@or-sdk/identifiers 0.27.11-beta.4281.0 → 0.28.1-beta.4282.0

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.28.0](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/identifiers@0.27.10...@or-sdk/identifiers@0.28.0) (2026-08-05)
+
+
+### Features
+
+* **packages:** add package descriptions and published files metadata ([801f823](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/commit/801f823034717ef8b961405a73d51ebc2ec07649))
+
+
+
 ## [0.27.10](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/identifiers@0.27.5...@or-sdk/identifiers@0.27.10) (2026-08-04)
 
 **Note:** Version bump only for package @or-sdk/identifiers

package/README.md

@@ -1,9 +1,23 @@
-## Installation:
+# `@or-sdk/identifiers`
+
+OneReach SDK client for Identifiers.
+
+## When to use
+
+- Use this package when integrating with the Identifiers capability on the OneReach platform.
+- Use its typed client and exported models instead of hand-writing requests to that service.
+
+## When not to use
+
+- Do not use it for a different platform capability; choose the dedicated `@or-sdk/*` package instead.
+- Do not use it for generic third-party HTTP calls.
+
+## Installation
 ```
 $ npm i @or-sdk/identifiers
 ```
 
-## Usage:
+## Usage
 ```typescript
 import { Identifiers } from '@or-sdk/identifiers'
 
@@ -19,3 +33,45 @@ const identifiers = new Identifiers({
   discoveryUrl: 'http://example.discovery/endpoint'
 });
  ```
+
+## Configuration
+
+- Prefer `sdkUrl` when the service URL is known; it avoids a discovery request.
+- Use `discoveryUrl` only when the service URL is not available.
+- Provide `token` as a bearer-token string or getter where supported.
+
+## Common pitfalls
+
+- Keep the client token current when it can expire; a token getter is preferable where the constructor accepts one.
+- Treat the generated TypeScript types as the authoritative contract for optional parameters and response shapes.
+
+## Method map
+
+| Method | Purpose |
+|---|---|
+| `init(...)` | See the exported TypeScript signature for parameters and result. |
+| `listIdentifiers(...)` | See the exported TypeScript signature for parameters and result. |
+| `listIdentifierGroups(...)` | See the exported TypeScript signature for parameters and result. |
+| `getIdentifier(...)` | See the exported TypeScript signature for parameters and result. |
+| `getIdentifierGroup(...)` | See the exported TypeScript signature for parameters and result. |
+| `listObtainableIdentifiers(...)` | See the exported TypeScript signature for parameters and result. |
+| `releaseIdentifier(...)` | See the exported TypeScript signature for parameters and result. |
+| `buyIdentifier(...)` | See the exported TypeScript signature for parameters and result. |
+| `createProvider(...)` | See the exported TypeScript signature for parameters and result. |
+| `listProviders(...)` | See the exported TypeScript signature for parameters and result. |
+| `deleteProvider(...)` | See the exported TypeScript signature for parameters and result. |
+
+## More detail
+
+Full signatures and exported types are available in `src/` and `dist/types/`.
+
+
+## Additional API reference
+
+Methods below were missing from the package guide. Signatures and return types are taken directly from the exported source API.
+
+### `Identifiers`
+
+| Method | Returns | Purpose |
+|---|---|---|
+| `listIdentifiersTriggers(identifiers: List<SingleIdentifier>)` | `Promise<List<IdentifierTrigger>>` | Load list of identifier gateway triggers by identifier list. |

package/package.json

@@ -1,12 +1,31 @@
 {
   "name": "@or-sdk/identifiers",
-  "version": "0.27.11-beta.4281.0",
+  "version": "0.28.1-beta.4282.0",
+  "description": "OneReach SDK client for Identifiers",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "dependencies": {
+    "@or-sdk/base": "^0.44.8-beta.4282.0",
+    "@or-sdk/sdk-api": "^0.30.1-beta.4282.0"
+  },
+  "devDependencies": {
+    "concurrently": "^9.2.0",
+    "typescript": "^5.6.2",
+    "vitest": "^4.1.10"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
-    "build": "pnpm clean && concurrently 'pnpm:build:*(!watch)'",
+    "build": "concurrently 'pnpm:build:*(!watch)'",
     "build:cjs": "tsc --project tsconfig.json",
     "build:esm": "tsc --project tsconfig.esm.json",
     "build:types": "tsc --project tsconfig.types.json",
@@ -19,16 +38,5 @@
     "dev": "pnpm build:watch:esm",
     "test": "vitest --run",
     "test:watch": "vitest --watch"
-  },
-  "dependencies": {
-    "@or-sdk/base": "^0.44.7",
-    "@or-sdk/sdk-api": "^0.29.6-beta.4281.0"
-  },
-  "devDependencies": {
-    "concurrently": "9.0.1",
-    "typescript": "5.6.2"
-  },
-  "publishConfig": {
-    "access": "public"
   }
-}
+}

package/src/__tests__/identifiers.spec.ts

@@ -32,7 +32,7 @@ describe('identifiers.Identifiers', () => {
       } catch (error) {
         const e = error as TokenIsMissedError;
         expect(e.message).toBe(
-          new TokenIsMissedError().message
+          new TokenIsMissedError().message,
         );
       }
     });
@@ -64,7 +64,7 @@ describe('identifiers.Identifiers', () => {
         } catch (error) {
           const e = error as SdkUrlOrDiscoveryUrlIsMissedError;
           expect(e.message).toBe(
-            new SdkUrlOrDiscoveryUrlIsMissedError().message
+            new SdkUrlOrDiscoveryUrlIsMissedError().message,
           );
         }
       });

package/src/identifiers.ts

@@ -166,7 +166,7 @@ export class Identifiers {
    * @return List<ObtainableIdentifier>
    */
   public async listObtainableIdentifiers(
-    params: ObtainableIdentifierRequestParams = {}
+    params: ObtainableIdentifierRequestParams = {},
   ): Promise<List<ObtainableIdentifier>> {
     const result = await this._sdkApi.makeRequest<ObtainableIdentifier[]>({
       method: 'GET',
@@ -209,7 +209,7 @@ export class Identifiers {
    * ```
    */
   public async buyIdentifier(
-    identifiers: ObtainableIdentifier | ObtainableIdentifier[]
+    identifiers: ObtainableIdentifier | ObtainableIdentifier[],
   ): Promise<BuyIdentifierResponse> {
     const data = {
       identifiers: Array.isArray(identifiers) ? identifiers : [identifiers],
@@ -236,7 +236,7 @@ export class Identifiers {
    */
   public async createProvider(
     provider: IdentifierProvider['name'],
-    settings: IdentifierProvider['settings'] = {}
+    settings: IdentifierProvider['settings'] = {},
   ): Promise<void> {
     const data = {
       provider,

package/tsconfig.build.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "./src"
-  },
-  "exclude": [
-    "./src/__tests__"
-  ]
-}

package/tsconfig.dev.json

@@ -1,7 +0,0 @@
-{
-  "extends": "./tsconfig.esm.json",
-  "compilerOptions": {
-    "declarationDir": "./dist/types",
-    "declaration": true
-  }
-}

package/tsconfig.esm.json

@@ -1,11 +0,0 @@
-{
-  "extends": "./tsconfig.build.json",
-  "compilerOptions": {
-    "outDir": "./dist/esm",
-    "declarationDir": "./dist/types",
-    "module": "ES6",
-    "target": "es6",
-    "declaration": true,
-    "declarationMap": true
-  }
-}

package/tsconfig.json

@@ -1,6 +0,0 @@
-{
-  "extends": "./tsconfig.build.json",
-  "compilerOptions": {
-    "outDir": "./dist/cjs"
-  }
-}

package/tsconfig.types.json

@@ -1,10 +0,0 @@
-{
-  "extends": "./tsconfig.build.json",
-  "compilerOptions": {
-    "outDir": "./dist/types",
-    "declaration": true,
-    "declarationMap": true,
-    "emitDeclarationOnly": true,
-    "removeComments": false
-  }
-}

package/vitest.config.mjs

@@ -1,25 +0,0 @@
-import { defineConfig } from 'vitest/config';
-
-export default defineConfig({
-  test: {
-    reporters: ['junit', 'default'],
-    outputFile: 'test-results/junit.xml',
-    include: ['src/**/*.{test,spec}.ts'],
-    exclude: ['dist/**'],
-    coverage: {
-      reporter: ['text', 'json', 'html', 'cobertura', 'text-summary'],
-      clean: true,
-      include: [
-        'src/**',
-      ],
-      exclude: [
-        'src/types.ts',
-        '**/*.spec.ts',
-      ],
-    },
-    globals: true,
-    environment: 'node',
-    clearMocks: true,
-    watch: false,
-  },
-});