{"id":18458326,"url":"https://github.com/crazyfactory/pim-aurelia-sdk","last_synced_at":"2025-06-19T09:34:11.036Z","repository":{"id":74458871,"uuid":"55759503","full_name":"crazyfactory/pim-aurelia-sdk","owner":"crazyfactory","description":null,"archived":false,"fork":false,"pushed_at":"2017-02-09T05:51:53.000Z","size":247,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-06-04T20:23:44.455Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crazyfactory.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-04-08T07:31:41.000Z","updated_at":"2016-05-06T06:27:59.000Z","dependencies_parsed_at":"2023-07-30T00:15:55.994Z","dependency_job_id":null,"html_url":"https://github.com/crazyfactory/pim-aurelia-sdk","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/crazyfactory/pim-aurelia-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyfactory%2Fpim-aurelia-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyfactory%2Fpim-aurelia-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyfactory%2Fpim-aurelia-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyfactory%2Fpim-aurelia-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crazyfactory","download_url":"https://codeload.github.com/crazyfactory/pim-aurelia-sdk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyfactory%2Fpim-aurelia-sdk/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260724746,"owners_count":23052800,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T08:17:52.095Z","updated_at":"2025-06-19T09:34:06.015Z","avatar_url":"https://github.com/crazyfactory.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pim-aurelia-sdk\n\nThis SDK offers easy access to the Crazy Factory PIM API for Aurelia based web apps.\n\n## Installation\n\nThe SDK should be installed as an aliased JSPM Package.\n\n   ```shell\n   jspm install pim-api=github:crazyfactory/pim-aurelia-sdk\n   ```\n\n## Usage\n\nBasic example for retrieving data\n\n```typescript\n// Import an Api class\nimport {CurrenciesApi} from 'pim-api';\n\n// Instantiate with default settings (you may pass a config object)\nlet currenciesApi = new CurrenciesApi();\n\n// Call the API to get Data\ncurrenciesApi.get(\"USD\").then((res) =\u003e {\n    // handle result\n}).fail((e) =\u003e {\n    // handle error\n});\n```\n\nBasic example for storing data\n\n```typescript\n// Import an Api class\nimport {CurrenciesApi} from 'pim-api';\nimport {ICurrencyData} from 'pim-data';\n\n// Create a new currency\nlet data: ICurrencyData = {\n    Key: \"EUR\",\n    Name: \"Euro\"\n};\n\n// Instantiate it (you may pass a config object)\nlet currenciesApi = new CurrenciesApi();\n\n// Call the API to get Data\ncurrenciesApi.create(data).then((res) =\u003e {\n    // handle result\n}).fail((e) =\u003e {\n    // handle error\n});\n```\n\n## Building The Code\n\nTo build the code, follow these steps.\n\n1. Ensure that [NodeJS](http://nodejs.org/) is installed. This provides the platform on which the build tooling runs.\n2. From the project folder, execute the following command:\n\n   ```shell\n   npm install\n   ```\n3. Ensure that [Gulp](http://gulpjs.com/) is installed. If you need to install it, use the following command:\n\n   ```shell\n   npm install -g gulp\n   ```\n4. To build the code, you can now run:\n\n   ```shell\n   gulp build\n   ```\n5. You will find the compiled code in the `dist` folder, available in three module formats: AMD, CommonJS and ES6.\n\n6. See `gulpfile.js` for other tasks related to generating the docs and linting.\n\n## Running The Tests\n\nTo run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:\n\n1. Ensure that the [Karma](http://karma-runner.github.io/) CLI is installed. If you need to install it, use the following command:\n\n   ```shell\n   npm install -g karma-cli\n   ```\n2. Ensure that [jspm](http://jspm.io/) is installed. If you need to install it, use the following commnand:\n\n   ```shell\n   npm install -g jspm\n   ```\n3. Install the client-side dependencies with jspm:\n\n   ```shell\n   jspm install\n   ```\n\n4. You can now run the tests with this command:\n\n   ```shell\n   karma start\n   ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrazyfactory%2Fpim-aurelia-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrazyfactory%2Fpim-aurelia-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrazyfactory%2Fpim-aurelia-sdk/lists"}