{"_id":"@dx-samples/one-page-wonder-types","_rev":"6-a185fedc0e775b91fc7030c996c74c49","name":"@dx-samples/one-page-wonder-types","dist-tags":{"next":"6.0.3","latest":"6.0.4"},"versions":{"6.0.0":{"name":"@dx-samples/one-page-wonder-types","version":"6.0.0","description":"Module to ship WCH data content.","keywords":["data bundle","watson content hub","wchtools"],"bugs":{"url":"https://github.ibm.com/DX-Samples/one-page-wonder-types"},"license":"MIT","author":{"name":"Dr. Carsten Leue"},"config":{"data":"./data"},"dependencies":{"@dx-samples/common-types":"^6.0.0","tslib":"^1.9.0"},"devDependencies":{"@angular/compiler":"^6.0.2","@angular/compiler-cli":"^6.0.2","@angular/core":"^6.0.2","@ibm-wch-sdk/cli":"^6.0.0","cpx":"^1.5.0","ng-packagr":"^3.0.0-rc.5","npm-run-all":"^4.1.2","rxjs":"^6.1.0","sync-files":"^1.0.3","ts-node":"~4.1.0","tsickle":"^0.27.2","tslib":"^1.9.0","typescript":"~2.7.2","zone.js":"^0.8.26"},"peerDependencies":{},"engines":{"node":">= 7.0","npm":">= 5.0"},"publishConfig":{"access":"public"},"wchtools-dependencies":["./data","@dx-samples/common-types"],"main":"bundles/dx-samples-one-page-wonder-types.umd.js","module":"fesm5/dx-samples-one-page-wonder-types.js","es2015":"fesm2015/dx-samples-one-page-wonder-types.js","esm5":"esm5/dx-samples-one-page-wonder-types.js","esm2015":"esm2015/dx-samples-one-page-wonder-types.js","fesm5":"fesm5/dx-samples-one-page-wonder-types.js","fesm2015":"fesm2015/dx-samples-one-page-wonder-types.js","typings":"dx-samples-one-page-wonder-types.d.ts","metadata":"dx-samples-one-page-wonder-types.metadata.json","sideEffects":false,"_id":"@dx-samples/one-page-wonder-types@6.0.0","_npmVersion":"5.6.0","_nodeVersion":"8.11.2","_npmUser":{"name":"carstenleue","email":"carsten.leue@de.ibm.com"},"dist":{"integrity":"sha512-RbDtx8ykqJq0+YjenY9bCSqB4424dI3hQswxNaoCrEN6Esu/NOU2f49Yi6o5FQueKAt6KSZR8wPr5mqbexMfWg==","shasum":"8f53e98e21999f7fb2c410322d84a96a97b7f035","tarball":"https://registry.npmjs.org/@dx-samples/one-page-wonder-types/-/one-page-wonder-types-6.0.0.tgz","fileCount":23,"unpackedSize":39108,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJa/ruACRA9TVsSAnZWagAAnjIQAI2qj0J6Cux9mmHUGGj4\nbIo1h9Msg2sBZMbwzojpa7U06oo3tf8j0hzERao6KPrHJI+9NX25l80icJDq\n73Q7HBMcgwijg1ZGyMSy+DFl+qyXbAAU1qBSObdxe+0XOe5tkqFoT8YcnXse\nkX3Ya/5XhPaxJvTrbGQJ86XlPW1iOLaW0UItXMfRrdEH1k5tRSyQWHZzKIws\nUaAF8jkd5dCmgJiZ5Wb9XnKD2okrNC/X2ygWAb9WD9SqeJMpnxl2HxwT6J3/\nQ6EmEPcy63RFmKbmLd7DZXFrOCaeYzwtEF2MmWaydtW2OIoa+aK2k7jtMMOq\nnYE+4CXtIx3tn82F4Z/I59d+kB12COfqIILzDlhWbnXr7A5ptEuYPzo8+8Ev\n0HEZTBxYEB1zqHou46jyqcX4r5Rcck2Z6wChs0wyLrLiLy5te0yJjML1HrFz\n99uO5g3gcMfCRj/vZaq91jcgbCLxXFtDd/uVW85xKqf2ztFwH7HCXSSGqj7A\nnU0p4ug5hDN0vMf8b07Fooy1RemWCMt63inoU8BwVEWjwnAZRRbK2xwEappa\npRcrDuQfOIYEz4X0xK/ZB7XiAQPiV96VPeN/q1RpWd7DmIcv3snfkr7TIlmR\nltUz8a/h+ELdhHF9Zc2bcmyE+nuXJUBvvFgxP8n4TIHgngPJvft8hG9qvNOw\nRqiF\r\n=77el\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDHBMZkrT3ejXHCD+oP9nx8wZeGp38QlPGG5vXdygcMRgIgZLpau06bNqWD1JM6y90JGHeCOAAJyR5UKIZc3iAFfMg="}]},"maintainers":[{"name":"carstenleue","email":"carsten.leue@de.ibm.com"},{"name":"sterbling","email":"sterbling@de.ibm.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/one-page-wonder-types_6.0.0_1526643583756_0.45272565084722816"},"_hasShrinkwrap":false},"6.0.1":{"name":"@dx-samples/one-page-wonder-types","version":"6.0.1","description":"Module to ship WCH data content.","keywords":["data bundle","watson content hub","wchtools"],"bugs":{"url":"https://github.ibm.com/DX-Samples/one-page-wonder-types"},"license":"MIT","author":{"name":"Dr. Carsten Leue"},"config":{"data":"./data"},"dependencies":{"@dx-samples/common-types":"^6.0.0","tslib":"^1.9.0"},"devDependencies":{"@angular/compiler":"^6.0.2","@angular/compiler-cli":"^6.0.2","@angular/core":"^6.0.2","@ibm-wch-sdk/cli":"^6.0.0","cpx":"^1.5.0","ng-packagr":"^3.0.0-rc.5","npm-run-all":"^4.1.2","rxjs":"^6.1.0","sync-files":"^1.0.3","ts-node":"~4.1.0","tsickle":"^0.27.2","tslib":"^1.9.0","typescript":"~2.7.2","zone.js":"^0.8.26"},"peerDependencies":{},"engines":{"node":">= 7.0","npm":">= 5.0"},"publishConfig":{"access":"public"},"wchtools-dependencies":["./data","@dx-samples/common-types"],"main":"bundles/dx-samples-one-page-wonder-types.umd.js","module":"fesm5/dx-samples-one-page-wonder-types.js","es2015":"fesm2015/dx-samples-one-page-wonder-types.js","esm5":"esm5/dx-samples-one-page-wonder-types.js","esm2015":"esm2015/dx-samples-one-page-wonder-types.js","fesm5":"fesm5/dx-samples-one-page-wonder-types.js","fesm2015":"fesm2015/dx-samples-one-page-wonder-types.js","typings":"dx-samples-one-page-wonder-types.d.ts","metadata":"dx-samples-one-page-wonder-types.metadata.json","sideEffects":false,"readme":"# one-page-wonder-types\n\nContainer project to bundle [WCH](https://www.ibm.com/products/watson-content-hub) data records as an [npm](http://npmjs.com/) module. Such a module can then be used as a dependency by single page application projects to populate a tenant with data.\n\n## Setup\n\n* Create a new repository on github.\n* Invoke `git remote add upstream git@github.ibm.com:DX-Samples/one-page-wonder-types.git` on the command line.\n* Invoke `git pull upstream master` to get the initial content.\n* Invoke `git push` to push the initial content to your repository.\n* Modify name and description in the [package.json](https://docs.npmjs.com/files/package.json) file (and probably author and repository URL).\n\n## Get Ready\n\nIn order to add content to your project you will need to use [wchtools](https://www.npmjs.com/package/wchtools-cli) to pull data in the correct format from your tenant. Apply the following steps to prepare your environment.\n\n* Follow the steps outlined in [Credential Management](https://www.npmjs.com/package/ibm-wch-sdk-cli#credential-management) to store your credentials.\n* Modify username and [API URL](https://developer.ibm.com/customer-engagement/tutorials/getting-started-api-javascript/#tocstep1) in the file `data/.wchtoolsoptions.json`.\n\n## Add Data\n\nIn general you only want to ship a subset of all data deployed to your [WCH Tenant](https://www.ibm.com/products/watson-content-hub) in your library. These data records have to be placed in the `data` folder. We suggest the following process to identify the correct data set:\n\n* First pull all data into a temporary folder.\n* Then use a merge tool to selectively only copy the relevant files into the `data` folder. We like [BeyondCompare](https://www.scootersoftware.com/) for this step, but you are free to use any tool.\n\n### Pull data into a temp folder\n\nUse the following command:\n\n```bash\nnpm run gen:pull\n```\n\nThis will copy all data into a `tmp` folder. This folder will be excluded from your repository automatically, you do not need to care about its size. It's also OK to delete the folder.\n\n### Identify the correct subset\n\nIt makes sense to distinguish between two types of data, very similar to `interfaces` and `implementation` in a coding environment.\n\n**Interfaces**: this subset contains all content types, image profiles, etc that describe your data model in WCH. This also includes all assets referenced by these artifacts, such as thumbnail images or referenced categories. There is no automated way to identify the complete set, you will have to select the desired types and then manually follow all dependencies.\n\n**Implementation**: this subset contains the content items, assets, renditions, etc based on the interface types.\n\nBoth aspects of your data should be shipped as separate modules, because they might be used as prerequisites by other projects. Consider for example a UI library that contains UI components that can be reused on your single page application. This UI library would prereq the interface module, since it builds on top of the content types. But it has no dependency on the actual data content. In fact there even might be different implementation data sets all building on top of a common interface module.\n\n### Specify dependencies\n\nIf you are packaging an implementation like library, you will have to specify the interface library (and potentially others) as dependencies:\n\n* Add the module identifier of your dependency to your [package.json](https://docs.npmjs.com/files/package.json) file in the `dependencies` section.\n* Add the module name to the list of `wchtools-dependencies`.\n\npackage.json:\n\n```json\n\"dependencies\": {\n  \"my-interface-module\": \"*\"\n},\n\"wchtools-dependencies\": [\n  \"./data\", \"my-interface-module\"\n]\n```\n\n## Test your package\n\nSince the process to select your data subset is basically manual, it is pretty error prone. You want to test your package before shipping it. For this purpose we recommend to always work against an empty tenant.\n\nDelete all content. Use with care, this really deletes all content on the tenant. Only execute this if you have made a backup.\n\n```bash\nnpm run deploy:delete\n```\n\nDeploy your library:\n\n```bash\nnpm run deploy:push\n```\n\nThe `deploy:push` command should run without errors.\n\n## Build and Deploy your package\n\nWe need to prepare our package in the correct format and then publish it to [npm](http://npmjs.com/).\n\nRun the following to prepare your package in a suitable format:\n\n```bash\nnpm run build\n```\n\nThis creates the desired artifacts in the `dist` folder.\n\nRun the following to [publish](https://docs.npmjs.com/cli/publish) your package to the registry.\n\n```bash\nnpm publish dist\n```\n\n## Automated Build\n\nWe recommend to build and deploy your package automatically, e.g. by using [Travis CI](https://travis.ibm.com). Edit the `.travis.yml` file and add your email address.\n\nIn the [Travis CI](https://travis.ibm.com) add a secure environment variable `NPM_TOKEN` and enter your [npm token](https://docs.npmjs.com/getting-started/working_with_tokens).\n\nYour project will then be deployed automatically whenever you execute a [tagged git commit](https://git-scm.com/book/en/v2/Git-Basics-Tagging).\n\n### Git Lifecycle\n\nExecute your git check-ins as usual. Whenever you push, this will trigger a new [Travis CI](https://travis.ibm.com) build. When you are ready to release a new version, call:\n\n```bash\nnpm version minor\ngit push --follow-tags\n```\n\nFor reference see the documentation on [npm version](https://docs.npmjs.com/cli/version) and [git push](https://git-scm.com/docs/git-push#git-push---follow-tags).","readmeFilename":"README.md","_id":"@dx-samples/one-page-wonder-types@6.0.1","_npmVersion":"5.6.0","_nodeVersion":"8.11.2","_npmUser":{"name":"carstenleue","email":"carsten.leue@de.ibm.com"},"dist":{"integrity":"sha512-djkaCwDvG3dIBHH+FWvXR3oZPkfxHEXhy8TNsrLMYThIQmtxbOeno1NCrVkmfez30XMYjqi8WrOKDGJGvp4aZw==","shasum":"2efc8c5b2ef8a720e129f09fbbaac95ca8f0931f","tarball":"https://registry.npmjs.org/@dx-samples/one-page-wonder-types/-/one-page-wonder-types-6.0.1.tgz","fileCount":23,"unpackedSize":39113,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJa/tQyCRA9TVsSAnZWagAA1WYP/RghCY9q/WQDeImVCPsd\neTemW7FnYJ6QzvaZkE0ZSmIQTkyYHbYCTNJa/WtoTc4nNOVxbKG7q2AVmJtE\nMsB+VZ/aWpwRleD6DluK9IpC0kLKVArJgHx24kiuZFoUoNMyjD4j+6bL2u2A\nQ29BdbCrReo64YIajUaTTjtRqwsytHcnB8cjfwwFok25LW7awkXMR1aRBxzx\nlYUcdBRy5dDh4PaHw7jYu1UNBTq5goyZ6uxTEU464AhZl9/VDu5qqIhaSMU8\na07eCbF+voKg42/oR/tFnjSXj+2ab6GdN4kOi5stxj+uClz+ig8P8gCYEJsd\nM/gtlZzgQjymEmt6HheG4lA6MFQcaNh3iWOBywPVAOtmgD4AIYXPlZRk/eCT\n00psOyitQysuFrpiIRIeNOKfnkd+OBrOwPOGFzendNVr5IOygz4Jd6Ntn5+Q\n94F8f5PBuzsItj2FZMgdRX7FPU+22mK3d6CaMlHolXwccWEiAb+XRLsV/MpS\nUam8oyIEpeglLsBlgcqE4BbywbDm4FFqDYPaDgB7AEU8cmwAv91Yur4V2eIW\nxV/EwrGc0J9m4Rx0oEaEki0grclDYo5sJSjhG5JjYzQkjila59odS91TGHnZ\n0frK0Hj/6lQBGIeggA2xQmNrfDtUBx6aJ95R6ZWewgQUWGTeuWvTeFQUbFoM\nIPQE\r\n=F872\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCGibONYvABgDF//N+ARsfYU+ttW4bMKPGDWi3OdXmkrQIhAPRenyg8VSikNizNplZkArBX4hG4tn592bxWaDsP5EGC"}]},"maintainers":[{"name":"carstenleue","email":"carsten.leue@de.ibm.com"},{"name":"sterbling","email":"sterbling@de.ibm.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/one-page-wonder-types_6.0.1_1526649905773_0.8945928383959891"},"_hasShrinkwrap":false},"6.0.2":{"name":"@dx-samples/one-page-wonder-types","version":"6.0.2","description":"Module to ship WCH data content.","keywords":["data bundle","watson content hub","wchtools"],"bugs":{"url":"https://github.ibm.com/DX-Samples/one-page-wonder-types"},"license":"MIT","author":{"name":"Dr. Carsten Leue"},"config":{"data":"./data"},"dependencies":{"@dx-samples/common-types":"^6.0.0","tslib":"^1.9.0"},"devDependencies":{"@angular/compiler":"^6.0.2","@angular/compiler-cli":"^6.0.2","@angular/core":"^6.0.2","@ibm-wch-sdk/cli":"^6.0.0","cpx":"^1.5.0","ng-packagr":"^3.0.0-rc.5","npm-run-all":"^4.1.2","rxjs":"^6.1.0","sync-files":"^1.0.3","ts-node":"~4.1.0","tsickle":"^0.27.2","tslib":"^1.9.0","typescript":"~2.7.2","zone.js":"^0.8.26"},"peerDependencies":{},"engines":{"node":">= 7.0","npm":">= 5.0"},"publishConfig":{"access":"public"},"wchtools-dependencies":["./data","@dx-samples/common-types"],"main":"bundles/dx-samples-one-page-wonder-types.umd.js","module":"fesm5/dx-samples-one-page-wonder-types.js","es2015":"fesm2015/dx-samples-one-page-wonder-types.js","esm5":"esm5/dx-samples-one-page-wonder-types.js","esm2015":"esm2015/dx-samples-one-page-wonder-types.js","fesm5":"fesm5/dx-samples-one-page-wonder-types.js","fesm2015":"fesm2015/dx-samples-one-page-wonder-types.js","typings":"dx-samples-one-page-wonder-types.d.ts","metadata":"dx-samples-one-page-wonder-types.metadata.json","sideEffects":false,"readme":"# one-page-wonder-types\n\nContainer project to bundle [WCH](https://www.ibm.com/products/watson-content-hub) data records as an [npm](http://npmjs.com/) module. Such a module can then be used as a dependency by single page application projects to populate a tenant with data.\n\n## Setup\n\n* Create a new repository on github.\n* Invoke `git remote add upstream git@github.ibm.com:DX-Samples/one-page-wonder-types.git` on the command line.\n* Invoke `git pull upstream master` to get the initial content.\n* Invoke `git push` to push the initial content to your repository.\n* Modify name and description in the [package.json](https://docs.npmjs.com/files/package.json) file (and probably author and repository URL).\n\n## Get Ready\n\nIn order to add content to your project you will need to use [wchtools](https://www.npmjs.com/package/wchtools-cli) to pull data in the correct format from your tenant. Apply the following steps to prepare your environment.\n\n* Follow the steps outlined in [Credential Management](https://www.npmjs.com/package/ibm-wch-sdk-cli#credential-management) to store your credentials.\n* Modify username and [API URL](https://developer.ibm.com/customer-engagement/tutorials/getting-started-api-javascript/#tocstep1) in the file `data/.wchtoolsoptions.json`.\n\n## Add Data\n\nIn general you only want to ship a subset of all data deployed to your [WCH Tenant](https://www.ibm.com/products/watson-content-hub) in your library. These data records have to be placed in the `data` folder. We suggest the following process to identify the correct data set:\n\n* First pull all data into a temporary folder.\n* Then use a merge tool to selectively only copy the relevant files into the `data` folder. We like [BeyondCompare](https://www.scootersoftware.com/) for this step, but you are free to use any tool.\n\n### Pull data into a temp folder\n\nUse the following command:\n\n```bash\nnpm run gen:pull\n```\n\nThis will copy all data into a `tmp` folder. This folder will be excluded from your repository automatically, you do not need to care about its size. It's also OK to delete the folder.\n\n### Identify the correct subset\n\nIt makes sense to distinguish between two types of data, very similar to `interfaces` and `implementation` in a coding environment.\n\n**Interfaces**: this subset contains all content types, image profiles, etc that describe your data model in WCH. This also includes all assets referenced by these artifacts, such as thumbnail images or referenced categories. There is no automated way to identify the complete set, you will have to select the desired types and then manually follow all dependencies.\n\n**Implementation**: this subset contains the content items, assets, renditions, etc based on the interface types.\n\nBoth aspects of your data should be shipped as separate modules, because they might be used as prerequisites by other projects. Consider for example a UI library that contains UI components that can be reused on your single page application. This UI library would prereq the interface module, since it builds on top of the content types. But it has no dependency on the actual data content. In fact there even might be different implementation data sets all building on top of a common interface module.\n\n### Specify dependencies\n\nIf you are packaging an implementation like library, you will have to specify the interface library (and potentially others) as dependencies:\n\n* Add the module identifier of your dependency to your [package.json](https://docs.npmjs.com/files/package.json) file in the `dependencies` section.\n* Add the module name to the list of `wchtools-dependencies`.\n\npackage.json:\n\n```json\n\"dependencies\": {\n  \"my-interface-module\": \"*\"\n},\n\"wchtools-dependencies\": [\n  \"./data\", \"my-interface-module\"\n]\n```\n\n## Test your package\n\nSince the process to select your data subset is basically manual, it is pretty error prone. You want to test your package before shipping it. For this purpose we recommend to always work against an empty tenant.\n\nDelete all content. Use with care, this really deletes all content on the tenant. Only execute this if you have made a backup.\n\n```bash\nnpm run deploy:delete\n```\n\nDeploy your library:\n\n```bash\nnpm run deploy:push\n```\n\nThe `deploy:push` command should run without errors.\n\n## Build and Deploy your package\n\nWe need to prepare our package in the correct format and then publish it to [npm](http://npmjs.com/).\n\nRun the following to prepare your package in a suitable format:\n\n```bash\nnpm run build\n```\n\nThis creates the desired artifacts in the `dist` folder.\n\nRun the following to [publish](https://docs.npmjs.com/cli/publish) your package to the registry.\n\n```bash\nnpm publish dist\n```\n\n## Automated Build\n\nWe recommend to build and deploy your package automatically, e.g. by using [Travis CI](https://travis.ibm.com). Edit the `.travis.yml` file and add your email address.\n\nIn the [Travis CI](https://travis.ibm.com) add a secure environment variable `NPM_TOKEN` and enter your [npm token](https://docs.npmjs.com/getting-started/working_with_tokens).\n\nYour project will then be deployed automatically whenever you execute a [tagged git commit](https://git-scm.com/book/en/v2/Git-Basics-Tagging).\n\n### Git Lifecycle\n\nExecute your git check-ins as usual. Whenever you push, this will trigger a new [Travis CI](https://travis.ibm.com) build. When you are ready to release a new version, call:\n\n```bash\nnpm version minor\ngit push --follow-tags\n```\n\nFor reference see the documentation on [npm version](https://docs.npmjs.com/cli/version) and [git push](https://git-scm.com/docs/git-push#git-push---follow-tags).","readmeFilename":"README.md","_id":"@dx-samples/one-page-wonder-types@6.0.2","_npmVersion":"5.6.0","_nodeVersion":"8.11.2","_npmUser":{"name":"carstenleue","email":"carsten.leue@de.ibm.com"},"dist":{"integrity":"sha512-kEBA0JLHCfHLwuhMYY1KVS3+IJjK0BRliF1C637s2ZDz4FRK4ItAwIRsCTdLjJrWU8vsYASXGL5vVqSTxkp7Eg==","shasum":"9877acf4ea513b238b68473c8b65ca5f3c1cf372","tarball":"https://registry.npmjs.org/@dx-samples/one-page-wonder-types/-/one-page-wonder-types-6.0.2.tgz","fileCount":23,"unpackedSize":39113,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJa/tmRCRA9TVsSAnZWagAAMngP/iYuNnSE/rUlZg8QTPSQ\n3dz45psj+Plvgdc+SqEtJk8mvDHHm2sC9+8WTDKyB7HnslpKlZ3dAVxRB55M\nrg64XMphOJI6S6XIdIvzbPmLaxC8712vmrVOhj11Q9FJxtRKqJOMzEUPLP32\nhAuBZw7H14D1VLLLHjQfhaHiepPe/cCwy4FmIKtZyIsZzOTE2gNnZccybNXE\n8bEBvnCRDAFS1VHutBNWeIxNyrxvcLhBMZCxCBb7U7R2iOgydFiVAYusf/fd\nY2diovj8FtRuPALSln23BJkxNPTiKlxCrbfF7I9h3Ltjt2sJ4CB0wc15Vt4x\nOz2D2p2VZfjsjSvJK9On1qsi9ZYPhwjBwsfBFJ4GJS7De7vnaNqfOKsgUl2F\nBEuwOGJpRwkAU5QiKadmvfBbVfvrweN1TFWzQkAJhzqvJiwNt+rDJSZYDtsy\nWWPjy0l1FAaj0WEhlVyxjJ4qOAmenMg4od4qX4vc47v+ZiGxb4ZYCvmlj9yO\n3MjgYAqUT3w037qJcJKWIMuxzK0DZmknuBnoPFXGt77Invjrzi2sQHC7nZ76\n5hCw25mSfQaGUYHy7+sIRzHmZvMDrFE34shJLS/Ovosqu+N5Wqpp5m09Q+Vc\nGI/rWLjxoIiO/yO8UjbE8HE2La5j93p0CNr8pPRylmV7Q/ncAb/5Ff0iMci2\nEJb7\r\n=AB/+\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDUB3Qc6DBbAGkl6zxsZRMN8tyAGNZPrqrarhfmT5cVygIgcvR4L2uGf8dMWrri0AWgGvFr4+gQXDWoPEtMM/rhUk0="}]},"maintainers":[{"name":"carstenleue","email":"carsten.leue@de.ibm.com"},{"name":"sterbling","email":"sterbling@de.ibm.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/one-page-wonder-types_6.0.2_1526651280549_0.08110879240366642"},"_hasShrinkwrap":false},"6.0.3":{"name":"@dx-samples/one-page-wonder-types","version":"6.0.3","description":"Module to ship WCH data content.","keywords":["data bundle","watson content hub","wchtools"],"bugs":{"url":"https://github.ibm.com/DX-Samples/one-page-wonder-types"},"license":"MIT","author":{"name":"Dr. Carsten Leue"},"config":{"data":"./data"},"dependencies":{"@dx-samples/common-types":"^6.0.0","tslib":"^1.9.0"},"devDependencies":{"@angular/compiler":"^6.0.2","@angular/compiler-cli":"^6.0.2","@angular/core":"^6.0.2","@ibm-wch-sdk/cli":"^6.0.0","cpx":"^1.5.0","ng-packagr":"^3.0.0-rc.5","npm-run-all":"^4.1.2","rxjs":"^6.1.0","sync-files":"^1.0.3","ts-node":"~4.1.0","tsickle":"^0.27.2","tslib":"^1.9.0","typescript":"~2.7.2","zone.js":"^0.8.26"},"peerDependencies":{},"engines":{"node":">= 7.0","npm":">= 5.0"},"publishConfig":{"access":"public"},"wchtools-dependencies":["./data","@dx-samples/common-types"],"main":"bundles/dx-samples-one-page-wonder-types.umd.js","module":"fesm5/dx-samples-one-page-wonder-types.js","es2015":"fesm2015/dx-samples-one-page-wonder-types.js","esm5":"esm5/dx-samples-one-page-wonder-types.js","esm2015":"esm2015/dx-samples-one-page-wonder-types.js","fesm5":"fesm5/dx-samples-one-page-wonder-types.js","fesm2015":"fesm2015/dx-samples-one-page-wonder-types.js","typings":"dx-samples-one-page-wonder-types.d.ts","metadata":"dx-samples-one-page-wonder-types.metadata.json","sideEffects":false,"readme":"# one-page-wonder-types\n\nContainer project to bundle [WCH](https://www.ibm.com/products/watson-content-hub) data records as an [npm](http://npmjs.com/) module. Such a module can then be used as a dependency by single page application projects to populate a tenant with data.\n\n## Setup\n\n* Create a new repository on github.\n* Invoke `git remote add upstream git@github.ibm.com:DX-Samples/one-page-wonder-types.git` on the command line.\n* Invoke `git pull upstream master` to get the initial content.\n* Invoke `git push` to push the initial content to your repository.\n* Modify name and description in the [package.json](https://docs.npmjs.com/files/package.json) file (and probably author and repository URL).\n\n## Get Ready\n\nIn order to add content to your project you will need to use [wchtools](https://www.npmjs.com/package/wchtools-cli) to pull data in the correct format from your tenant. Apply the following steps to prepare your environment.\n\n* Follow the steps outlined in [Credential Management](https://www.npmjs.com/package/ibm-wch-sdk-cli#credential-management) to store your credentials.\n* Modify username and [API URL](https://developer.ibm.com/customer-engagement/tutorials/getting-started-api-javascript/#tocstep1) in the file `data/.wchtoolsoptions.json`.\n\n## Add Data\n\nIn general you only want to ship a subset of all data deployed to your [WCH Tenant](https://www.ibm.com/products/watson-content-hub) in your library. These data records have to be placed in the `data` folder. We suggest the following process to identify the correct data set:\n\n* First pull all data into a temporary folder.\n* Then use a merge tool to selectively only copy the relevant files into the `data` folder. We like [BeyondCompare](https://www.scootersoftware.com/) for this step, but you are free to use any tool.\n\n### Pull data into a temp folder\n\nUse the following command:\n\n```bash\nnpm run gen:pull\n```\n\nThis will copy all data into a `tmp` folder. This folder will be excluded from your repository automatically, you do not need to care about its size. It's also OK to delete the folder.\n\n### Identify the correct subset\n\nIt makes sense to distinguish between two types of data, very similar to `interfaces` and `implementation` in a coding environment.\n\n**Interfaces**: this subset contains all content types, image profiles, etc that describe your data model in WCH. This also includes all assets referenced by these artifacts, such as thumbnail images or referenced categories. There is no automated way to identify the complete set, you will have to select the desired types and then manually follow all dependencies.\n\n**Implementation**: this subset contains the content items, assets, renditions, etc based on the interface types.\n\nBoth aspects of your data should be shipped as separate modules, because they might be used as prerequisites by other projects. Consider for example a UI library that contains UI components that can be reused on your single page application. This UI library would prereq the interface module, since it builds on top of the content types. But it has no dependency on the actual data content. In fact there even might be different implementation data sets all building on top of a common interface module.\n\n### Specify dependencies\n\nIf you are packaging an implementation like library, you will have to specify the interface library (and potentially others) as dependencies:\n\n* Add the module identifier of your dependency to your [package.json](https://docs.npmjs.com/files/package.json) file in the `dependencies` section.\n* Add the module name to the list of `wchtools-dependencies`.\n\npackage.json:\n\n```json\n\"dependencies\": {\n  \"my-interface-module\": \"*\"\n},\n\"wchtools-dependencies\": [\n  \"./data\", \"my-interface-module\"\n]\n```\n\n## Test your package\n\nSince the process to select your data subset is basically manual, it is pretty error prone. You want to test your package before shipping it. For this purpose we recommend to always work against an empty tenant.\n\nDelete all content. Use with care, this really deletes all content on the tenant. Only execute this if you have made a backup.\n\n```bash\nnpm run deploy:delete\n```\n\nDeploy your library:\n\n```bash\nnpm run deploy:push\n```\n\nThe `deploy:push` command should run without errors.\n\n## Build and Deploy your package\n\nWe need to prepare our package in the correct format and then publish it to [npm](http://npmjs.com/).\n\nRun the following to prepare your package in a suitable format:\n\n```bash\nnpm run build\n```\n\nThis creates the desired artifacts in the `dist` folder.\n\nRun the following to [publish](https://docs.npmjs.com/cli/publish) your package to the registry.\n\n```bash\nnpm publish dist\n```\n\n## Automated Build\n\nWe recommend to build and deploy your package automatically, e.g. by using [Travis CI](https://travis.ibm.com). Edit the `.travis.yml` file and add your email address.\n\nIn the [Travis CI](https://travis.ibm.com) add a secure environment variable `NPM_TOKEN` and enter your [npm token](https://docs.npmjs.com/getting-started/working_with_tokens).\n\nYour project will then be deployed automatically whenever you execute a [tagged git commit](https://git-scm.com/book/en/v2/Git-Basics-Tagging).\n\n### Git Lifecycle\n\nExecute your git check-ins as usual. Whenever you push, this will trigger a new [Travis CI](https://travis.ibm.com) build. When you are ready to release a new version, call:\n\n```bash\nnpm version minor\ngit push --follow-tags\n```\n\nFor reference see the documentation on [npm version](https://docs.npmjs.com/cli/version) and [git push](https://git-scm.com/docs/git-push#git-push---follow-tags).","readmeFilename":"README.md","_id":"@dx-samples/one-page-wonder-types@6.0.3","_npmVersion":"5.6.0","_nodeVersion":"8.11.2","_npmUser":{"name":"carstenleue","email":"carsten.leue@de.ibm.com"},"dist":{"integrity":"sha512-eFR+B6/P+MlhB+cl4o/fhJNRKE9C1ZLK+NXGswuK3o1a4EPX3XdIJvSwEGkypAELR+xtISmiVdinoPLJY/0ILg==","shasum":"6c7fae43ebec84bdc1c812664bdc8f1de874fe40","tarball":"https://registry.npmjs.org/@dx-samples/one-page-wonder-types/-/one-page-wonder-types-6.0.3.tgz","fileCount":23,"unpackedSize":39133,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbHYDzCRA9TVsSAnZWagAAqRMP/0V2OzwH5jPnzWosrXLl\nllhYwTdLcZIhxiEXibo1ShfFJWnbNm35RW4ODERsLI5h1zuQTONjJx+D20zW\nXgigesk64U8fPi2sOVs47+oYIo51gxWul1UTX3JfneWu1cr7eRXY+6XcxHgF\n1PlbEpt+5NAb8M7bRIytHkHkspaKpUV5Xoefn4OcZfknFjDWQyCZStZNqHxz\n9EzwqTvUKrsBf8Aa3Zw104YJzXg2JGqodC4pMCMLKdFj2EMcCwRtPrJrotgQ\nH3obtvrqIY2PWIHzdHf0BaB+Jy7GhZWGLcq7g15JFLpVqoA0yKEe3Zlw2OP9\ne2Vrc4kEf2v+SGnpSM8F+0FkFylrNeQSEFYgJdo5XXI7AZco+OdTvLv325jg\nzHLjMZHrmjWC9uj7looThy36nfCCOGpdci6Nsk6d+ubdgTxz5e26zPc8F0Ys\nkGMyA5lPdMSh8Z7hyNDlYRue8xEnQza55jc/XqYi3qJNT/vIdo4qNzqJSp3a\nMPhQcM7R5+xto6NWz+Ck3zf9+mFaPobTWt7F5SIlVmdItpAUXXBgZj94nJku\ndA0wDz80R6AEoKpm3Xi06046ByUbjkVmA/LVTYlk8BWppU0j9R5/UyYhxvgw\n7Lo8TzmgpmP+1Goh5Bf/7HQqzWZc4GUatCHtPDCLDenlgkNkF+5fLCZTgQY2\ngOG0\r\n=eWe9\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIG1BFIlQSG1kBpB0S4mL1jfza3SoDWTYi3v7X8ZoL45sAiEA+gBh2hc5JlQP73wlj/D4s2L6HKcS4TsU3Mx6PqPL/7c="}]},"maintainers":[{"name":"carstenleue","email":"carsten.leue@de.ibm.com"},{"name":"sterbling","email":"sterbling@de.ibm.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/one-page-wonder-types_6.0.3_1528660210841_0.504770854293418"},"_hasShrinkwrap":false},"6.0.4":{"name":"@dx-samples/one-page-wonder-types","version":"6.0.4","description":"Module to ship WCH data content.","keywords":["data bundle","watson content hub","wchtools"],"bugs":{"url":"https://github.ibm.com/DX-Samples/one-page-wonder-types"},"license":"MIT","author":{"name":"Dr. Carsten Leue"},"config":{"data":"./data"},"dependencies":{"@dx-samples/common-types":"^6.0.0","tslib":"^1.9.0"},"devDependencies":{"@angular/compiler":"^6.0.2","@angular/compiler-cli":"^6.0.2","@angular/core":"^6.0.2","@ibm-wch-sdk/cli":"^6.0.0","cpx":"^1.5.0","ng-packagr":"^3.0.0-rc.5","npm-run-all":"^4.1.2","rxjs":"^6.1.0","sync-files":"^1.0.3","ts-node":"~4.1.0","tsickle":"^0.27.2","tslib":"^1.9.0","typescript":"~2.7.2","zone.js":"^0.8.26"},"peerDependencies":{},"engines":{"node":">= 7.0","npm":">= 5.0"},"publishConfig":{"access":"public"},"wchtools-dependencies":["./data","@dx-samples/common-types"],"main":"bundles/dx-samples-one-page-wonder-types.umd.js","module":"fesm5/dx-samples-one-page-wonder-types.js","es2015":"fesm2015/dx-samples-one-page-wonder-types.js","esm5":"esm5/dx-samples-one-page-wonder-types.js","esm2015":"esm2015/dx-samples-one-page-wonder-types.js","fesm5":"fesm5/dx-samples-one-page-wonder-types.js","fesm2015":"fesm2015/dx-samples-one-page-wonder-types.js","typings":"dx-samples-one-page-wonder-types.d.ts","metadata":"dx-samples-one-page-wonder-types.metadata.json","sideEffects":false,"_id":"@dx-samples/one-page-wonder-types@6.0.4","_npmVersion":"5.6.0","_nodeVersion":"8.11.2","_npmUser":{"name":"carstenleue","email":"carsten.leue@de.ibm.com"},"dist":{"integrity":"sha512-geImuNNW5yVxAqrFk5vwXrJEmarc3fh6SO83e40YiuHKmwN5UpdYBLqjzFViFqy2T/gK6r1nL6HOMdcsYAEQFQ==","shasum":"ef273c3c61457e15c3bec511f36a279ec051e0d6","tarball":"https://registry.npmjs.org/@dx-samples/one-page-wonder-types/-/one-page-wonder-types-6.0.4.tgz","fileCount":23,"unpackedSize":39195,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbHYnFCRA9TVsSAnZWagAAd2AP/3TSYyi0RhC0yB97bLZC\nWlFq2VYMCbHWQotj7YRGvdMQ/bnFPfdyNdwXy9pbawgWtmP8FFJVRmhtyHra\nAGCDRVEFgwGB8EZtoPW4Z2Zu9HjhDjpMfxo7gCBLxTmshX7zfv1zdKEQ1uJ5\naU6UMlSHobrwX6Hlo6/Jj/00EgncuGlvFeZRYx+1I0PoJemDFGgBCsm1XJPo\n7TreeZTMUWpii6CUaUnqV/CLoNkSHYIrKIlROuz72icRzceNQ2U5Y7yEF8Ea\nHd9TM72Pd0qcTgt46mypw4/I4p8FMBbSyjBgHZ9TEGwJfkC3mgTFv+Hyug4H\nq+BfSVG8BJ1/WWRtVA03eBJS5NrzfdD53A7HyY/ypXbGLNF6ccTDEIrcDUS5\n5MxPY7ri7muJnKo82fNnEM3QaG4gKkTCLinaBjJQd7tIGpVaGcdQ13mxpMUE\n7hYszobCY0yBvPzy06/RFnbP2SYx3c6RYzm3GZVl5NZ3gotXtz+FwgtIKZpf\nN/qMri2IjCOpF6v86DW3Ab15xWYOlVOmcgX1J1MwfPkdv943mZWkh5JBm7Tg\nccLAz3oBfCLv3slVZ5asS2PPyMeem463hpL8tz4f5kdaJwGc5kQi2RwWKYYZ\nXzmR7Rbxha48EWcdhndRcz/RJFv5XKCNyTXKl1jTDYxGN/tkQBRqeqrcK3iq\naoze\r\n=3sUs\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICife8Ez6lRICq4h/qlqZQklIOgaNFuszlq+lXKhC33CAiB0BveZPHaZbMNAB6hpFMuzSAQBtM30Q7coYn31uQNoLA=="}]},"maintainers":[{"name":"carstenleue","email":"carsten.leue@de.ibm.com"},{"name":"sterbling","email":"sterbling@de.ibm.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/one-page-wonder-types_6.0.4_1528662468573_0.21413723042524757"},"_hasShrinkwrap":false}},"time":{"created":"2018-05-18T11:39:43.648Z","6.0.0":"2018-05-18T11:39:43.833Z","modified":"2022-04-05T06:13:30.656Z","6.0.1":"2018-05-18T13:25:05.906Z","6.0.2":"2018-05-18T13:48:00.680Z","6.0.3":"2018-06-10T19:50:10.965Z","6.0.4":"2018-06-10T20:27:48.668Z"},"maintainers":[{"email":"mike.burati@acoustic.com","name":"mburati"},{"email":"carsten.leue@de.ibm.com","name":"carstenleue"},{"email":"sterbling@de.ibm.com","name":"sterbling"}],"description":"Module to ship WCH data content.","keywords":["data bundle","watson content hub","wchtools"],"author":{"name":"Dr. Carsten Leue"},"bugs":{"url":"https://github.ibm.com/DX-Samples/one-page-wonder-types"},"license":"MIT","readme":"# one-page-wonder-types\n\nContainer project to bundle [WCH](https://www.ibm.com/products/watson-content-hub) data records as an [npm](http://npmjs.com/) module. Such a module can then be used as a dependency by single page application projects to populate a tenant with data.\n\n## Setup\n\n* Create a new repository on github.\n* Invoke `git remote add upstream git@github.ibm.com:DX-Samples/one-page-wonder-types.git` on the command line.\n* Invoke `git pull upstream master` to get the initial content.\n* Invoke `git push` to push the initial content to your repository.\n* Modify name and description in the [package.json](https://docs.npmjs.com/files/package.json) file (and probably author and repository URL).\n\n## Get Ready\n\nIn order to add content to your project you will need to use [wchtools](https://www.npmjs.com/package/wchtools-cli) to pull data in the correct format from your tenant. Apply the following steps to prepare your environment.\n\n* Follow the steps outlined in [Credential Management](https://www.npmjs.com/package/ibm-wch-sdk-cli#credential-management) to store your credentials.\n* Modify username and [API URL](https://developer.ibm.com/customer-engagement/tutorials/getting-started-api-javascript/#tocstep1) in the file `data/.wchtoolsoptions.json`.\n\n## Add Data\n\nIn general you only want to ship a subset of all data deployed to your [WCH Tenant](https://www.ibm.com/products/watson-content-hub) in your library. These data records have to be placed in the `data` folder. We suggest the following process to identify the correct data set:\n\n* First pull all data into a temporary folder.\n* Then use a merge tool to selectively only copy the relevant files into the `data` folder. We like [BeyondCompare](https://www.scootersoftware.com/) for this step, but you are free to use any tool.\n\n### Pull data into a temp folder\n\nUse the following command:\n\n```bash\nnpm run gen:pull\n```\n\nThis will copy all data into a `tmp` folder. This folder will be excluded from your repository automatically, you do not need to care about its size. It's also OK to delete the folder.\n\n### Identify the correct subset\n\nIt makes sense to distinguish between two types of data, very similar to `interfaces` and `implementation` in a coding environment.\n\n**Interfaces**: this subset contains all content types, image profiles, etc that describe your data model in WCH. This also includes all assets referenced by these artifacts, such as thumbnail images or referenced categories. There is no automated way to identify the complete set, you will have to select the desired types and then manually follow all dependencies.\n\n**Implementation**: this subset contains the content items, assets, renditions, etc based on the interface types.\n\nBoth aspects of your data should be shipped as separate modules, because they might be used as prerequisites by other projects. Consider for example a UI library that contains UI components that can be reused on your single page application. This UI library would prereq the interface module, since it builds on top of the content types. But it has no dependency on the actual data content. In fact there even might be different implementation data sets all building on top of a common interface module.\n\n### Specify dependencies\n\nIf you are packaging an implementation like library, you will have to specify the interface library (and potentially others) as dependencies:\n\n* Add the module identifier of your dependency to your [package.json](https://docs.npmjs.com/files/package.json) file in the `dependencies` section.\n* Add the module name to the list of `wchtools-dependencies`.\n\npackage.json:\n\n```json\n\"dependencies\": {\n  \"my-interface-module\": \"*\"\n},\n\"wchtools-dependencies\": [\n  \"./data\", \"my-interface-module\"\n]\n```\n\n## Test your package\n\nSince the process to select your data subset is basically manual, it is pretty error prone. You want to test your package before shipping it. For this purpose we recommend to always work against an empty tenant.\n\nDelete all content. Use with care, this really deletes all content on the tenant. Only execute this if you have made a backup.\n\n```bash\nnpm run deploy:delete\n```\n\nDeploy your library:\n\n```bash\nnpm run deploy:push\n```\n\nThe `deploy:push` command should run without errors.\n\n## Build and Deploy your package\n\nWe need to prepare our package in the correct format and then publish it to [npm](http://npmjs.com/).\n\nRun the following to prepare your package in a suitable format:\n\n```bash\nnpm run build\n```\n\nThis creates the desired artifacts in the `dist` folder.\n\nRun the following to [publish](https://docs.npmjs.com/cli/publish) your package to the registry.\n\n```bash\nnpm publish dist\n```\n\n## Automated Build\n\nWe recommend to build and deploy your package automatically, e.g. by using [Travis CI](https://travis.ibm.com). Edit the `.travis.yml` file and add your email address.\n\nIn the [Travis CI](https://travis.ibm.com) add a secure environment variable `NPM_TOKEN` and enter your [npm token](https://docs.npmjs.com/getting-started/working_with_tokens).\n\nYour project will then be deployed automatically whenever you execute a [tagged git commit](https://git-scm.com/book/en/v2/Git-Basics-Tagging).\n\n### Git Lifecycle\n\nExecute your git check-ins as usual. Whenever you push, this will trigger a new [Travis CI](https://travis.ibm.com) build. When you are ready to release a new version, call:\n\n```bash\nnpm version minor\ngit push --follow-tags\n```\n\nFor reference see the documentation on [npm version](https://docs.npmjs.com/cli/version) and [git push](https://git-scm.com/docs/git-push#git-push---follow-tags).","readmeFilename":"README.md"}