{"id":43589257,"url":"https://github.com/xivapi/angular-client","last_synced_at":"2026-02-04T01:48:44.671Z","repository":{"id":32817415,"uuid":"143298452","full_name":"xivapi/angular-client","owner":"xivapi","description":"xivapi client library (service and models)  for angular applications","archived":false,"fork":false,"pushed_at":"2023-07-20T06:04:18.000Z","size":3163,"stargazers_count":4,"open_issues_count":3,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-11-23T18:21:46.251Z","etag":null,"topics":["xivapi"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xivapi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-02T13:28:11.000Z","updated_at":"2023-06-10T21:17:43.000Z","dependencies_parsed_at":"2023-02-19T00:01:28.675Z","dependency_job_id":null,"html_url":"https://github.com/xivapi/angular-client","commit_stats":null,"previous_names":[],"tags_count":51,"template":false,"template_full_name":null,"purl":"pkg:github/xivapi/angular-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xivapi%2Fangular-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xivapi%2Fangular-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xivapi%2Fangular-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xivapi%2Fangular-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xivapi","download_url":"https://codeload.github.com/xivapi/angular-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xivapi%2Fangular-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29064007,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-04T00:26:14.114Z","status":"ssl_error","status_checked_at":"2026-02-04T00:23:06.435Z","response_time":96,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["xivapi"],"created_at":"2026-02-04T01:48:42.282Z","updated_at":"2026-02-04T01:48:44.659Z","avatar_url":"https://github.com/xivapi.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# angular-client\n\n[![CircleCI](https://circleci.com/gh/xivapi/angular-client/tree/master.svg?style=shield)](https://circleci.com/gh/xivapi/angular-client/tree/master)\n[![npm version](https://badge.fury.io/js/%40xivapi%2Fangular-client.svg)](https://www.npmjs.com/package/@xivapi/angular-client)\n\n## Documentation\n\nVisit https://xivapi.com/docs for documentation about the web api mapped by this client.\n\nFurther documentation for this library available on documentation website: https://xivapi.github.io/angular-client/\n\n## Installation\n\nSimply run `npm i --save @xivapi/angular-client`\n\n## Quick start\n\nAdd `XivapiClientModule` to your `AppModule` imports:\n\n```ts\n@NgModule({\n    declarations: [\n        AppComponent,\n    ],\n    imports: [\n        ...\n        XivapiClientModule.forRoot(),        \n        ...\n    ],\n    bootstrap: [AppComponent]\n})\nexport class AppModule {\n}\n```\n\nIn the other modules, don't call `forRoot` again, just import the module itself.\n\nThen you can simply inject the service wherever you want to use it:\n\n```ts\n@Component({\n    ...\n})\nexport class FooComponent {\n    \n    public items$: Observable\u003cXivapiList\u003cany\u003e\u003e;\n    \n    constructor(private xivapi: XivapiService){\n        this.items$ = this.xivapi.getList(XivapiEndpoint.Items);\n    }\n}\n```\n\n## Use with private_key (Google Cloud Function)\n\n- Create a google cloud function, name it as you want.\n- Insert following code (with your key):\n ```js\n exports.xivapiProxy = (req, res) =\u003e {\n   let request = require('request');\n   const apiKey = '\u003cyour api key\u003e\u003e';\n   res.set('Access-Control-Allow-Origin', '\u003cyour allowed origins\u003e')\n      .set('Access-Control-Allow-Headers', 'Content-Type');\n   const url = Buffer.from(req.query.url, 'base64').toString();\n   request(\n     {\n       url:`${url}${url.indexOf('?') \u003e -1 ? '\u0026':'?'}private_key=${apiKey}`,\n     }, \n     function(error, response, body) {\n     let errorBody = JSON.parse(body);\n \tlet errorMessage = errorBody.error || errorBody.message;\n     if (error || errorMessage) {\n       res.status(400).send(errorMessage || 'Unknown Error');\n     } else {\n       res.status(200).set('Content-Type', 'application/json').send(body);\n     }\n   });\n };\n ```\n- Enable proxy mode inside the api module:\n ```ts\n    XivapiClientModule.forRoot('\u003cGCF trigger url\u003e')\n ```\n\nExample url: https://us-central1-myproject.cloudfunctions.net/xivapi-proxy\n\nKeep in mind that you can enable it based on the current environment, simply give `null` as proxy url if environment isn't prod,\nto use \"normal\" mode in order to get better debugging\nwhen using dev environment.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxivapi%2Fangular-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxivapi%2Fangular-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxivapi%2Fangular-client/lists"}