@comms-id/asx 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/asx
+
+Typed client for the Comms.ID ASX API (`https://api.comms.id/asx/v1`): ASX-listed companies: suggest as a user types, and look one up.
+
+`src/` is generated from the ASX contract (`packages/asx-service/openapi/asx.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 { createAsxClient } from "@comms-id/asx/server";
+
+const client = createAsxClient({
+  clientId: process.env.COMMS_ID_CLIENT_ID!,
+  privateJwk: JSON.parse(process.env.COMMS_ID_PRIVATE_JWK!),
+});
+const reply = await client.lookup({"ticker": "BHP"});
+```
+
+## Operations
+
+- `lookup`: Look up an ASX-listed company by ticker, live or from the stored directory.
+- `suggest`: Suggest ASX-listed companies for a ticker or name prefix, at most ten.
+
+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
+
+`createAsxFixtureClient()` from `@comms-id/asx/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 AsxClient } 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 createAsxBrowserClient: (options: BrowserOptions) => AsxClient;

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 createAsxBrowserClient = (options) => buildClient(createBrowserTransport(options));

package/dist/descriptor.d.ts

@@ -0,0 +1,15 @@
+export declare const asxProduct: {
+    readonly product: "asx";
+    readonly audience: "asx-lookup";
+    readonly scope: "asx";
+    readonly maxBodyBytes: 16384;
+    readonly operations: readonly [{
+        readonly name: "lookup";
+        readonly method: "POST";
+        readonly path: "/asx/v1/lookup";
+    }, {
+        readonly name: "suggest";
+        readonly method: "POST";
+        readonly path: "/asx/v1/suggest";
+    }];
+};

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 asxProduct = {
+    product: "asx",
+    audience: "asx-lookup",
+    scope: "asx",
+    maxBodyBytes: 16_384,
+    operations: [
+        {
+            "name": "lookup",
+            "method": "POST",
+            "path": "/asx/v1/lookup"
+        },
+        {
+            "name": "suggest",
+            "method": "POST",
+            "path": "/asx/v1/suggest"
+        }
+    ],
+};

package/dist/fixtures.d.ts

@@ -0,0 +1,5 @@
+import { type AsxClient } from "./generated/client.js";
+export { FIXTURE_HEADER, FIXTURE_NOTICE } from "./runtime/fixture-core.js";
+export declare const createAsxFixtureClient: () => AsxClient & {
+    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 createAsxFixtureClient = () => ({
+    ...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, SuggestRequest, SuggestResponse } from "./types.js";
+/** The client of Comms.ID ASX: one method for each operation. */
+export interface AsxClient {
+    /** Look up an ASX-listed company by ticker, live or from the stored directory. */
+    readonly lookup: (input: LookupRequest, options?: CallOptions) => Promise<LookupResponse>;
+    /** Suggest ASX-listed companies for a ticker or name prefix, at most ten. */
+    readonly suggest: (input: SuggestRequest, options?: CallOptions) => Promise<SuggestResponse>;
+}
+export declare const buildClient: (transport: TransportConfig) => AsxClient;

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),
+    suggest: (input, options) => call(transport, operations.suggest, 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,16 @@
+// 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 = {
+    "/asx/v1/lookup": {
+        "status": "missing",
+        "source": "live",
+        "startedAt": "2026-10-03T00:00:00.000Z",
+        "observedAt": "2026-10-03T00:00:01.000Z"
+    },
+    "/asx/v1/suggest": {
+        "source": "live",
+        "directoryObservedAt": "2026-10-03T00:00:00.000Z",
+        "suggestions": []
+    }
+};

package/dist/generated/operations.d.ts

@@ -0,0 +1,6 @@
+import type { Operation } from "../runtime/http.js";
+export type OperationName = "lookup" | "suggest";
+/** The operations of Comms.ID ASX, 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[]>>;