@comms-id/company 0.2.0

package/LICENSE

@@ -0,0 +1,15 @@
+Copyright (c) 2026 COMMS.ID PTY LTD. Proprietary software; not open source.
+
+Subject to the Comms.ID policy agreement, you may install, copy, bundle, run and
+deliver this client or component within your applications, adapt the supplied
+component source, and use the designated local functions and fixtures offline.
+Hosted operations are provided by the Comms.ID service.
+
+You may keep replies for your own customers and transactions, and your registered
+application may relay requests for its own users.
+
+You may not republish these packages as a standalone offering, resell access, offer
+a substitute lookup service, or harvest replies to reconstruct or redistribute a
+source dataset.
+
+Preserve this notice and any applicable third-party notices.

package/README.md

@@ -0,0 +1,30 @@
+# @comms-id/company
+
+Typed client for the Comms.ID Company API (`https://api.comms.id/company/v1`): Australian companies from ASIC's public registers: search by name, look up one by ACN.
+
+`src/` is generated from the Company contract (`packages/asic-public-registers/openapi/company.v1.json`) by `@comms-id/forge-transformers`. Do not edit it: change the contract and run `pnpm --filter @comms-id/forge-transformers generate`.
+
+```ts
+import { createCompanyClient } from "@comms-id/company/server";
+
+const client = createCompanyClient({
+  clientId: process.env.COMMS_ID_CLIENT_ID!,
+  privateJwk: JSON.parse(process.env.COMMS_ID_PRIVATE_JWK!),
+});
+const reply = await client.lookup({"acn": "001234567"});
+```
+
+## Operations
+
+- `lookup`: Look up one nine-digit ACN in the company snapshot. ABN lookup is not offered in v1. At most ten rows; no uniqueness or complete history claim.
+- `search`: Search the company snapshot by case-insensitive name prefix and optional exact status. Default eight rows, maximum ten, no paging. A snapshot miss does not prove absence from the live register.
+
+Every operation is a read, safe to repeat, and is retried after a retryable failure. A reply that is not a match is one of the outcomes of the reply convention: an error with `outcomeOf(error)` of `no-match`, `source-unavailable` or `failed`; an outage is never a "no match".
+
+## Test it first
+
+`createCompanyFixtureClient()` from `@comms-id/company/fixtures` answers from the contract's own examples with no network and says so (`fixture: true`). To call the TEST service (synthetic replies, your development app's key), pass `environment: "test"`; going live changes only the environment and the key.
+
+Entries: `.` (types and errors, safe in a browser), `./server` (signs each call), `./browser` (your relay route; never signs), `./fixtures` (LOCAL FIXTURES, no network), `./descriptor` (what `@comms-id/relay` may forward).
+
+The package is private until the publishing path exists (#515). `LICENSE` is the consumer client licence.

package/dist/browser.d.ts

@@ -0,0 +1,5 @@
+import { type CompanyClient } from "./generated/client.js";
+import { type BrowserOptions } from "./runtime/browser-core.js";
+export type { Environment } from "./runtime/environment.js";
+export type { BrowserOptions, CapabilityOptions, RelayOptions } from "./runtime/browser-core.js";
+export declare const createCompanyBrowserClient: (options: BrowserOptions) => CompanyClient;

package/dist/browser.js

@@ -0,0 +1,6 @@
+// Generated by @comms-id/forge-transformers from the service's OpenAPI contract. Do not edit: change the contract and regenerate.
+// Browser entry: it never signs and holds no secret. Use the consumer's relay route, or a
+// short-lived capability that the caller supplies.
+import { buildClient } from "./generated/client.js";
+import { createBrowserTransport } from "./runtime/browser-core.js";
+export const createCompanyBrowserClient = (options) => buildClient(createBrowserTransport(options));

package/dist/descriptor.d.ts

@@ -0,0 +1,15 @@
+export declare const companyProduct: {
+    readonly product: "company";
+    readonly audience: "asic-registers";
+    readonly scope: "asic-registers:read";
+    readonly maxBodyBytes: 16384;
+    readonly operations: readonly [{
+        readonly name: "lookup";
+        readonly method: "POST";
+        readonly path: "/company/v1/lookup";
+    }, {
+        readonly name: "search";
+        readonly method: "POST";
+        readonly path: "/company/v1/search";
+    }];
+};

package/dist/descriptor.js

@@ -0,0 +1,20 @@
+// Generated by @comms-id/forge-transformers from the service's OpenAPI contract. Do not edit: change the contract and regenerate.
+// The product descriptor that @comms-id/relay reads: which operations may be forwarded.
+export const companyProduct = {
+    product: "company",
+    audience: "asic-registers",
+    scope: "asic-registers:read",
+    maxBodyBytes: 16_384,
+    operations: [
+        {
+            "name": "lookup",
+            "method": "POST",
+            "path": "/company/v1/lookup"
+        },
+        {
+            "name": "search",
+            "method": "POST",
+            "path": "/company/v1/search"
+        }
+    ],
+};

package/dist/fixtures.d.ts

@@ -0,0 +1,5 @@
+import { type CompanyClient } from "./generated/client.js";
+export { FIXTURE_HEADER, FIXTURE_NOTICE } from "./runtime/fixture-core.js";
+export declare const createCompanyFixtureClient: () => CompanyClient & {
+    readonly fixture: true;
+};

package/dist/fixtures.js

@@ -0,0 +1,10 @@
+// Generated by @comms-id/forge-transformers from the service's OpenAPI contract. Do not edit: change the contract and regenerate.
+// LOCAL FIXTURES: no network. The client runs the same request and reply checks as a real call.
+import { buildClient } from "./generated/client.js";
+import { fixtures } from "./generated/fixtures.js";
+import { createFixtureTransport } from "./runtime/fixture-core.js";
+export { FIXTURE_HEADER, FIXTURE_NOTICE } from "./runtime/fixture-core.js";
+export const createCompanyFixtureClient = () => ({
+    ...buildClient(createFixtureTransport(fixtures)),
+    fixture: true,
+});

package/dist/generated/client.d.ts

@@ -0,0 +1,10 @@
+import { type CallOptions, type TransportConfig } from "../runtime/http.js";
+import type { LookupRequest, LookupResponse, SearchRequest, SearchResponse } from "./types.js";
+/** The client of Comms.ID Company: one method for each operation. */
+export interface CompanyClient {
+    /** Look up one nine-digit ACN in the company snapshot. ABN lookup is not offered in v1. At most ten rows; no uniqueness or complete history claim. */
+    readonly lookup: (input: LookupRequest, options?: CallOptions) => Promise<LookupResponse>;
+    /** Search the company snapshot by case-insensitive name prefix and optional exact status. Default eight rows, maximum ten, no paging. A snapshot miss does not prove absence from the live register. */
+    readonly search: (input: SearchRequest, options?: CallOptions) => Promise<SearchResponse>;
+}
+export declare const buildClient: (transport: TransportConfig) => CompanyClient;

package/dist/generated/client.js

@@ -0,0 +1,7 @@
+// Generated by @comms-id/forge-transformers from the service's OpenAPI contract. Do not edit: change the contract and regenerate.
+import { call } from "../runtime/http.js";
+import { operations } from "./operations.js";
+export const buildClient = (transport) => ({
+    lookup: (input, options) => call(transport, operations.lookup, input, options),
+    search: (input, options) => call(transport, operations.search, input, options),
+});

package/dist/generated/fixtures.d.ts

@@ -0,0 +1,2 @@
+/** LOCAL FIXTURES: one canned reply for each operation path. Fake data. */
+export declare const fixtures: Readonly<Record<string, unknown>>;

package/dist/generated/fixtures.js

@@ -0,0 +1,85 @@
+// Generated by @comms-id/forge-transformers from the service's OpenAPI contract. Do not edit: change the contract and regenerate.
+// Every reply is the example in the contract.
+/** LOCAL FIXTURES: one canned reply for each operation path. Fake data. */
+export const fixtures = {
+    "/company/v1/lookup": {
+        "activatedAt": "2026-10-01T00:01:00Z",
+        "attribution": "Australian Securities and Investments Commission via data.gov.au; Creative Commons Attribution 3.0 Australia",
+        "generation": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+        "license": "http://creativecommons.org/licenses/by/3.0/au/",
+        "limit": 10,
+        "mode": "snapshot",
+        "offset": 0,
+        "records": [
+            {
+                "register": "companies",
+                "acn": "001234567",
+                "name": "EXAMPLE COMPANY PTY LTD",
+                "status": "Registered",
+                "abn": "99001234567",
+                "type": null,
+                "companyClass": null,
+                "subClass": null,
+                "registeredAt": null,
+                "deregisteredAt": null,
+                "previousState": null,
+                "stateRegistrationNumber": null,
+                "currentName": null,
+                "currentNameIndicator": null,
+                "currentNameStartedAt": null
+            }
+        ],
+        "register": "companies",
+        "source": {
+            "datasetId": "asic-companies",
+            "resourceId": "fictional-example",
+            "url": "https://data.gov.au/",
+            "modifiedAt": "2026-09-30T00:00:00Z",
+            "sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
+            "bytes": 100,
+            "format": "CSV",
+            "observedAt": "2026-10-01T00:00:00Z",
+            "license": "http://creativecommons.org/licenses/by/3.0/au/"
+        }
+    },
+    "/company/v1/search": {
+        "activatedAt": "2026-10-01T00:01:00Z",
+        "attribution": "Australian Securities and Investments Commission via data.gov.au; Creative Commons Attribution 3.0 Australia",
+        "generation": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+        "license": "http://creativecommons.org/licenses/by/3.0/au/",
+        "limit": 8,
+        "mode": "snapshot",
+        "offset": 0,
+        "records": [
+            {
+                "register": "companies",
+                "acn": "001234567",
+                "name": "EXAMPLE COMPANY PTY LTD",
+                "status": "Registered",
+                "abn": "99001234567",
+                "type": null,
+                "companyClass": null,
+                "subClass": null,
+                "registeredAt": null,
+                "deregisteredAt": null,
+                "previousState": null,
+                "stateRegistrationNumber": null,
+                "currentName": null,
+                "currentNameIndicator": null,
+                "currentNameStartedAt": null
+            }
+        ],
+        "register": "companies",
+        "source": {
+            "datasetId": "asic-companies",
+            "resourceId": "fictional-example",
+            "url": "https://data.gov.au/",
+            "modifiedAt": "2026-09-30T00:00:00Z",
+            "sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
+            "bytes": 100,
+            "format": "CSV",
+            "observedAt": "2026-10-01T00:00:00Z",
+            "license": "http://creativecommons.org/licenses/by/3.0/au/"
+        }
+    }
+};

package/dist/generated/operations.d.ts

@@ -0,0 +1,6 @@
+import type { Operation } from "../runtime/http.js";
+export type OperationName = "lookup" | "search";
+/** The operations of Comms.ID Company, with the schemas the client checks. */
+export declare const operations: Readonly<Record<OperationName, Operation>>;
+/** The error codes the contract documents for each operation. */
+export declare const errorCodes: Readonly<Record<OperationName, readonly string[]>>;