@simpleapps-com/augur-api 2026.11.4 → 2026.11.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/core/base-client.d.ts.map +1 -1
- package/dist/core/call-rules.d.ts +35 -0
- package/dist/core/call-rules.d.ts.map +1 -1
- package/dist/core/call.d.ts.map +1 -1
- package/dist/core/client-rules.d.ts +66 -36
- package/dist/core/client-rules.d.ts.map +1 -1
- package/dist/core/client.d.ts +12 -2
- package/dist/core/client.d.ts.map +1 -1
- package/dist/core/encoded-segment.d.ts +7 -1
- package/dist/core/encoded-segment.d.ts.map +1 -1
- package/dist/core/errors.d.ts.map +1 -1
- package/dist/core/http-rules.d.ts +0 -32
- package/dist/core/http-rules.d.ts.map +1 -1
- package/dist/core/proxy-rules.d.ts +53 -0
- package/dist/core/proxy-rules.d.ts.map +1 -1
- package/dist/core/registry-rules.d.ts +7 -0
- package/dist/core/registry-rules.d.ts.map +1 -1
- package/dist/core/registry.d.ts.map +1 -1
- package/dist/core/response-rules.d.ts +15 -0
- package/dist/core/response-rules.d.ts.map +1 -1
- package/dist/core/schemas.d.ts.map +1 -1
- package/dist/core/service-proxy.d.ts.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +434 -233
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +434 -233
- package/dist/index.mjs.map +1 -1
- package/dist/services/goog-mc/generated/schemas.d.ts +8 -0
- package/dist/services/goog-mc/generated/schemas.d.ts.map +1 -1
- package/dist/services/goog-mc/generated/types.d.ts +8 -0
- package/dist/services/goog-mc/generated/types.d.ts.map +1 -1
- package/dist/services/items/client.d.ts +1 -1
- package/dist/services/items/generated/endpoints.d.ts.map +1 -1
- package/dist/services/items/generated/schemas.d.ts +8 -0
- package/dist/services/items/generated/schemas.d.ts.map +1 -1
- package/dist/services/items/generated/types.d.ts +13 -4
- package/dist/services/items/generated/types.d.ts.map +1 -1
- package/dist/services/joomla/generated/endpoints.d.ts.map +1 -1
- package/dist/services/joomla/generated/schemas.d.ts +5 -0
- package/dist/services/joomla/generated/schemas.d.ts.map +1 -1
- package/dist/services/joomla/generated/types.d.ts +18 -2
- package/dist/services/joomla/generated/types.d.ts.map +1 -1
- package/dist/services/legacy/generated/endpoints.d.ts.map +1 -1
- package/dist/services/legacy/generated/schemas.d.ts +2 -0
- package/dist/services/legacy/generated/schemas.d.ts.map +1 -1
- package/dist/services/legacy/generated/types.d.ts +4 -0
- package/dist/services/legacy/generated/types.d.ts.map +1 -1
- package/dist/services/open-search/generated/endpoints.d.ts.map +1 -1
- package/dist/services/open-search/generated/schemas.d.ts +2 -0
- package/dist/services/open-search/generated/schemas.d.ts.map +1 -1
- package/dist/services/open-search/generated/types.d.ts +4 -0
- package/dist/services/open-search/generated/types.d.ts.map +1 -1
- package/dist/testing.d.ts.map +1 -1
- package/dist/testing.js +22 -9
- package/dist/testing.js.map +1 -1
- package/dist/testing.mjs +20 -9
- package/dist/testing.mjs.map +1 -1
- package/dist/utils/cross-site-auth.d.ts.map +1 -1
- package/package.json +2 -1
package/dist/testing.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/testing.ts"],"sourcesContent":["/**\n * Testing utilities for @simpleapps-com/augur-api\n *\n * Provides a Proxy-based deep mock factory that automatically creates\n * mock functions at any depth, matching the AugurAPI client shape.\n *\n * @example\n * ```typescript\n * import { createMockClient } from '@simpleapps-com/augur-api/testing';\n *\n * const { client, mocks } = createMockClient();\n * mocks.commerce.cartHeaders.lookup.mockResolvedValue({ data: [] });\n *\n * const result = await client.commerce.cartHeaders.lookup({ userId: 1 });\n * expect(mocks.commerce.cartHeaders.lookup.mock.calls[0]).toEqual([{ userId: 1 }]);\n * ```\n */\n\nimport type { AugurAPI } from \"./client\";\n\n/** Recorded call arguments */\nexport interface MockCall {\n args: unknown[];\n timestamp: number;\n}\n\n/** Call tracking state */\nexport interface MockState {\n calls: unknown[][];\n results: Array<{ type: \"return\" | \"throw\"; value: unknown }>;\n instances: unknown[];\n lastCall: unknown[] | undefined;\n}\n\n/** A mock function with call tracking and return-value control */\nexport interface MockFn {\n (...args: unknown[]): unknown;\n mock: MockState;\n mockReturnValue(value: unknown): MockFn;\n mockResolvedValue(value: unknown): MockFn;\n mockRejectedValue(value: unknown): MockFn;\n mockImplementation(fn: (...args: unknown[]) => unknown): MockFn;\n mockReset(): MockFn;\n mockClear(): MockFn;\n}\n\n/** Recursively maps AugurAPI to MockFn leaves */\nexport type DeepMockClient<T> = {\n [K in keyof T]: T[K] extends (...args: never[]) => unknown ? MockFn : DeepMockClient<T[K]>;\n};\n\n/** Return type of createMockClient */\nexport interface MockClientResult {\n client: AugurAPI;\n mocks: DeepMockClient<AugurAPI>;\n}\n\n/** Create a stub function with full call-tracking */\nfunction createStubFn(): MockFn {\n let implementation: ((...args: unknown[]) => unknown) | null = null;\n\n const state: MockState = {\n calls: [],\n results: [],\n instances: [],\n lastCall: undefined,\n };\n\n const fn = function mockFn(this: unknown, ...args: unknown[]): unknown {\n state.calls.push(args);\n state.lastCall = args;\n state.instances.push(this);\n\n try {\n const result = implementation ? implementation(...args) : undefined;\n state.results.push({ type: \"return\", value: result });\n return result;\n } catch (error: unknown) {\n state.results.push({ type: \"throw\", value: error });\n throw error;\n }\n } as MockFn;\n\n fn.mock = state;\n\n fn.mockReturnValue = (value: unknown): MockFn => {\n implementation = () => value;\n return fn;\n };\n\n fn.mockResolvedValue = (value: unknown): MockFn => {\n implementation = () => Promise.resolve(value);\n return fn;\n };\n\n fn.mockRejectedValue = (value: unknown): MockFn => {\n implementation = () => Promise.reject(value);\n return fn;\n };\n\n fn.mockImplementation = (implFn: (...args: unknown[]) => unknown): MockFn => {\n implementation = implFn;\n return fn;\n };\n\n fn.mockReset = (): MockFn => {\n state.calls = [];\n state.results = [];\n state.instances = [];\n state.lastCall = undefined;\n implementation = null;\n return fn;\n };\n\n fn.mockClear = (): MockFn => {\n state.calls = [];\n state.results = [];\n state.instances = [];\n state.lastCall = undefined;\n return fn;\n };\n\n return fn;\n}\n\n/** Property names that belong to MockFn — triggers stub creation */\nconst MOCK_FN_PROPS = new Set([\n \"mock\",\n \"mockReturnValue\",\n \"mockResolvedValue\",\n \"mockRejectedValue\",\n \"mockImplementation\",\n \"mockReset\",\n \"mockClear\",\n]);\n\n/**\n * Create a recursive Proxy that lazily materializes MockFn stubs at any property access\n * depth. Each proxy holds its own stub: a chain always reaches the same cached child proxy,\n * so `mocks.a.b` and `client.a.b` share one stub with no path key (a key built from the\n * path was only ever compared with itself, so no test could see it).\n */\nfunction createDeepProxy(): unknown {\n const cache = new Map<string | symbol, unknown>();\n let stub: MockFn | undefined;\n const ownStub = (): MockFn => (stub ??= createStubFn());\n\n // The target only has to be callable so the `apply` trap fires; calls never\n // reach it. Function.prototype is callable and adds no uncovered code.\n return new Proxy(Function.prototype, {\n get(_target: object, prop: string | symbol): unknown {\n // Prevent spurious thenable detection (await/Promise.resolve)\n if (prop === \"then\") return undefined;\n\n // Support typeof checks\n if (prop === Symbol.toPrimitive) return undefined;\n if (prop === Symbol.iterator) return undefined;\n if (prop === Symbol.toStringTag) return \"MockProxy\";\n\n // MockFn property access — create stub eagerly and delegate\n if (typeof prop === \"string\" && MOCK_FN_PROPS.has(prop)) {\n return (ownStub() as unknown as Record<string, unknown>)[prop];\n }\n\n // Return cached child proxy\n if (cache.has(prop)) {\n return cache.get(prop);\n }\n\n // Create child proxy for the next level\n const child = createDeepProxy();\n cache.set(prop, child);\n return child;\n },\n\n apply(_target: object, thisArg: unknown, args: unknown[]): unknown {\n return ownStub().apply(thisArg, args);\n },\n });\n}\n\n/**\n * Create a fully-mocked AugurAPI client.\n *\n * Every property chain resolves to either a nested namespace or a callable\n * MockFn. The same object serves as both `client` (passed to production code)\n * and `mocks` (used in assertions).\n *\n * @returns `{ client, mocks }` — same object, dual-typed for ergonomics\n *\n * @example\n * ```typescript\n * const { client, mocks } = createMockClient();\n *\n * // Stub a return value\n * mocks.items.products.get.mockResolvedValue({ data: { id: 1 } });\n *\n * // Call through the client\n * const result = await client.items.products.get(1);\n *\n * // Assert\n * expect(mocks.items.products.get.mock.calls).toHaveLength(1);\n * expect(mocks.items.products.get.mock.calls[0]).toEqual([1]);\n * ```\n */\nexport function createMockClient(): MockClientResult {\n const proxy = createDeepProxy();\n\n return {\n client: proxy as unknown as AugurAPI,\n mocks: proxy as unknown as DeepMockClient<AugurAPI>,\n };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AA0DA,SAAS,eAAuB;AAC9B,MAAI,iBAA2D;AAE/D,QAAM,QAAmB;AAAA,IACvB,OAAO,CAAC;AAAA,IACR,SAAS,CAAC;AAAA,IACV,WAAW,CAAC;AAAA,IACZ,UAAU;AAAA,EACZ;AAEA,QAAM,KAAK,SAAS,UAAyB,MAA0B;AACrE,UAAM,MAAM,KAAK,IAAI;AACrB,UAAM,WAAW;AACjB,UAAM,UAAU,KAAK,IAAI;AAEzB,QAAI;AACF,YAAM,SAAS,iBAAiB,eAAe,GAAG,IAAI,IAAI;AAC1D,YAAM,QAAQ,KAAK,EAAE,MAAM,UAAU,OAAO,OAAO,CAAC;AACpD,aAAO;AAAA,IACT,SAAS,OAAgB;AACvB,YAAM,QAAQ,KAAK,EAAE,MAAM,SAAS,OAAO,MAAM,CAAC;AAClD,YAAM;AAAA,IACR;AAAA,EACF;AAEA,KAAG,OAAO;AAEV,KAAG,kBAAkB,CAAC,UAA2B;AAC/C,qBAAiB,MAAM;AACvB,WAAO;AAAA,EACT;AAEA,KAAG,oBAAoB,CAAC,UAA2B;AACjD,qBAAiB,MAAM,QAAQ,QAAQ,KAAK;AAC5C,WAAO;AAAA,EACT;AAEA,KAAG,oBAAoB,CAAC,UAA2B;AACjD,qBAAiB,MAAM,QAAQ,OAAO,KAAK;AAC3C,WAAO;AAAA,EACT;AAEA,KAAG,qBAAqB,CAAC,WAAoD;AAC3E,qBAAiB;AACjB,WAAO;AAAA,EACT;AAEA,KAAG,YAAY,MAAc;AAC3B,UAAM,QAAQ,CAAC;AACf,UAAM,UAAU,CAAC;AACjB,UAAM,YAAY,CAAC;AACnB,UAAM,WAAW;AACjB,qBAAiB;AACjB,WAAO;AAAA,EACT;AAEA,KAAG,YAAY,MAAc;AAC3B,UAAM,QAAQ,CAAC;AACf,UAAM,UAAU,CAAC;AACjB,UAAM,YAAY,CAAC;AACnB,UAAM,WAAW;AACjB,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGA,IAAM,gBAAgB,oBAAI,IAAI;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAQD,SAAS,kBAA2B;AAClC,QAAM,QAAQ,oBAAI,IAA8B;AAChD,MAAI;AACJ,QAAM,UAAU,MAAe,SAAS,aAAa;AAIrD,SAAO,IAAI,MAAM,SAAS,WAAW;AAAA,IACnC,IAAI,SAAiB,MAAgC;AAEnD,UAAI,SAAS,OAAQ,QAAO;AAG5B,UAAI,SAAS,OAAO,YAAa,QAAO;AACxC,UAAI,SAAS,OAAO,SAAU,QAAO;AACrC,UAAI,SAAS,OAAO,YAAa,QAAO;AAGxC,UAAI,OAAO,SAAS,YAAY,cAAc,IAAI,IAAI,GAAG;AACvD,eAAQ,QAAQ,EAAyC,IAAI;AAAA,MAC/D;AAGA,UAAI,MAAM,IAAI,IAAI,GAAG;AACnB,eAAO,MAAM,IAAI,IAAI;AAAA,MACvB;AAGA,YAAM,QAAQ,gBAAgB;AAC9B,YAAM,IAAI,MAAM,KAAK;AACrB,aAAO;AAAA,IACT;AAAA,IAEA,MAAM,SAAiB,SAAkB,MAA0B;AACjE,aAAO,QAAQ,EAAE,MAAM,SAAS,IAAI;AAAA,IACtC;AAAA,EACF,CAAC;AACH;AA0BO,SAAS,mBAAqC;AACnD,QAAM,QAAQ,gBAAgB;AAE9B,SAAO;AAAA,IACL,QAAQ;AAAA,IACR,OAAO;AAAA,EACT;AACF;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../src/testing.ts","../src/core/proxy-rules.ts"],"sourcesContent":["/**\n * Testing utilities for @simpleapps-com/augur-api\n *\n * Provides a Proxy-based deep mock factory that automatically creates\n * mock functions at any depth, matching the AugurAPI client shape.\n *\n * @example\n * ```typescript\n * import { createMockClient } from '@simpleapps-com/augur-api/testing';\n *\n * const { client, mocks } = createMockClient();\n * mocks.commerce.cartHeaders.lookup.mockResolvedValue({ data: [] });\n *\n * const result = await client.commerce.cartHeaders.lookup({ userId: 1 });\n * expect(mocks.commerce.cartHeaders.lookup.mock.calls[0]).toEqual([{ userId: 1 }]);\n * ```\n */\n\nimport type { AugurAPI } from \"./client\";\nimport { mockPropRoute } from \"./core/proxy-rules\";\n\n/** Recorded call arguments */\nexport interface MockCall {\n args: unknown[];\n timestamp: number;\n}\n\n/** Call tracking state */\nexport interface MockState {\n calls: unknown[][];\n results: Array<{ type: \"return\" | \"throw\"; value: unknown }>;\n instances: unknown[];\n lastCall: unknown[] | undefined;\n}\n\n/** A mock function with call tracking and return-value control */\nexport interface MockFn {\n (...args: unknown[]): unknown;\n mock: MockState;\n mockReturnValue(value: unknown): MockFn;\n mockResolvedValue(value: unknown): MockFn;\n mockRejectedValue(value: unknown): MockFn;\n mockImplementation(fn: (...args: unknown[]) => unknown): MockFn;\n mockReset(): MockFn;\n mockClear(): MockFn;\n}\n\n/** Recursively maps AugurAPI to MockFn leaves */\nexport type DeepMockClient<T> = {\n [K in keyof T]: T[K] extends (...args: never[]) => unknown ? MockFn : DeepMockClient<T[K]>;\n};\n\n/** Return type of createMockClient */\nexport interface MockClientResult {\n client: AugurAPI;\n mocks: DeepMockClient<AugurAPI>;\n}\n\n/** Create a stub function with full call-tracking */\nfunction createStubFn(): MockFn {\n let implementation: ((...args: unknown[]) => unknown) | null = null;\n\n const state: MockState = {\n calls: [],\n results: [],\n instances: [],\n lastCall: undefined,\n };\n\n const fn = function mockFn(this: unknown, ...args: unknown[]): unknown {\n state.calls.push(args);\n state.lastCall = args;\n state.instances.push(this);\n\n try {\n const result = implementation ? implementation(...args) : undefined;\n state.results.push({ type: \"return\", value: result });\n return result;\n } catch (error: unknown) {\n state.results.push({ type: \"throw\", value: error });\n throw error;\n }\n } as MockFn;\n\n fn.mock = state;\n\n fn.mockReturnValue = (value: unknown): MockFn => {\n implementation = () => value;\n return fn;\n };\n\n fn.mockResolvedValue = (value: unknown): MockFn => {\n implementation = () => Promise.resolve(value);\n return fn;\n };\n\n fn.mockRejectedValue = (value: unknown): MockFn => {\n implementation = () => Promise.reject(value);\n return fn;\n };\n\n fn.mockImplementation = (implFn: (...args: unknown[]) => unknown): MockFn => {\n implementation = implFn;\n return fn;\n };\n\n fn.mockReset = (): MockFn => {\n state.calls = [];\n state.results = [];\n state.instances = [];\n state.lastCall = undefined;\n implementation = null;\n return fn;\n };\n\n fn.mockClear = (): MockFn => {\n state.calls = [];\n state.results = [];\n state.instances = [];\n state.lastCall = undefined;\n return fn;\n };\n\n return fn;\n}\n\n/** Property names that belong to MockFn — triggers stub creation */\nconst MOCK_FN_PROPS = new Set([\n \"mock\",\n \"mockReturnValue\",\n \"mockResolvedValue\",\n \"mockRejectedValue\",\n \"mockImplementation\",\n \"mockReset\",\n \"mockClear\",\n]);\n\n/**\n * Create a recursive Proxy that lazily materializes MockFn stubs at any property access\n * depth. Each proxy holds its own stub: a chain always reaches the same cached child proxy,\n * so `mocks.a.b` and `client.a.b` share one stub with no path key (a key built from the\n * path was only ever compared with itself, so no test could see it).\n */\nfunction createDeepProxy(): unknown {\n const cache = new Map<string | symbol, unknown>();\n let stub: MockFn | undefined;\n const ownStub = (): MockFn => (stub ??= createStubFn());\n\n // The target only has to be callable so the `apply` trap fires; calls never\n // reach it. Function.prototype is callable and adds no uncovered code.\n return new Proxy(Function.prototype, {\n get(_target: object, prop: string | symbol): unknown {\n // The route is the proved mockPropRoute: `then` absent (never a thenable for await or\n // Promise.resolve), toPrimitive and iterator absent (typeof checks), the tag for\n // toStringTag, the stub for a MockFn property, the cached child for a seen name\n const route = mockPropRoute(\n prop === \"then\",\n prop === Symbol.toPrimitive,\n prop === Symbol.iterator,\n prop === Symbol.toStringTag,\n typeof prop === \"string\" && MOCK_FN_PROPS.has(prop),\n cache.has(prop),\n );\n if (route === \"absent\") return undefined;\n if (route === \"tag\") return \"MockProxy\";\n // A \"stub\" route is only ever a string prop (a MockFn property name)\n if (route === \"stub\")\n return (ownStub() as unknown as Record<string, unknown>)[prop as string];\n if (route === \"cached\") return cache.get(prop);\n\n // Create child proxy for the next level\n const child = createDeepProxy();\n cache.set(prop, child);\n return child;\n },\n\n apply(_target: object, thisArg: unknown, args: unknown[]): unknown {\n return ownStub().apply(thisArg, args);\n },\n });\n}\n\n/**\n * Create a fully-mocked AugurAPI client.\n *\n * Every property chain resolves to either a nested namespace or a callable\n * MockFn. The same object serves as both `client` (passed to production code)\n * and `mocks` (used in assertions).\n *\n * @returns `{ client, mocks }` — same object, dual-typed for ergonomics\n *\n * @example\n * ```typescript\n * const { client, mocks } = createMockClient();\n *\n * // Stub a return value\n * mocks.items.products.get.mockResolvedValue({ data: { id: 1 } });\n *\n * // Call through the client\n * const result = await client.items.products.get(1);\n *\n * // Assert\n * expect(mocks.items.products.get.mock.calls).toHaveLength(1);\n * expect(mocks.items.products.get.mock.calls[0]).toEqual([1]);\n * ```\n */\nexport function createMockClient(): MockClientResult {\n const proxy = createDeepProxy();\n\n return {\n client: proxy as unknown as AugurAPI,\n mocks: proxy as unknown as DeepMockClient<AugurAPI>,\n };\n}\n","//@ backend dafny\nimport { foldMatchesFrom } from \"@atlas/utils/case\";\nimport { includesFrom } from \"@atlas/utils/includes\";\nimport { braced, templateNames } from \"@atlas/utils/uri\";\n\n/* How many leading arguments fill a method's path params (as many as both have: utils distance\n `min2`) and the folded-name match (utils case `foldMatchesFrom`) are `@atlas/utils`' since\n 2026-11-10. */\n\n/**\n * Legacy snake_case keys are renamed in a GET's query only: a POST or PUT body goes as given.\n *\n * @ensures exactly the model's RenamesWireParams\n */\nexport function renamesWireParams(method: string): boolean {\n //@ verify\n //@ ensures \\result <==> method === \"GET\"\n return method === \"GET\";\n}\n\n/**\n * An endpoint with no query params gets {} for a missing body (the hand-written `get` pattern).\n *\n * @ensures exactly the model's DefaultsEmptyBody\n */\nexport function defaultsEmptyBody(hasQueryParams: boolean, hasBody: boolean): boolean {\n //@ verify\n //@ ensures \\result <==> (!hasQueryParams && !hasBody)\n return !hasQueryParams && !hasBody;\n}\n\n/** What a data proxy does with a property. */\nexport type DataRoute = \"unwrap\" | \"nest\" | \"copy\";\n\n/**\n * A data proxy unwraps a method's answer to its data, nests an object, and copies the rest.\n *\n * @ensures exactly the model's DataProxyRoute\n */\nexport function dataProxyRoute(isFunction: boolean, isObject: boolean): DataRoute {\n //@ verify\n //@ ensures isFunction ==> \\result === \"unwrap\"\n //@ ensures !isFunction && isObject ==> \\result === \"nest\"\n //@ ensures !isFunction && !isObject ==> \\result === \"copy\"\n if (isFunction) return \"unwrap\";\n return isObject ? \"nest\" : \"copy\";\n}\n\n/** Where the mock client sends a property. */\nexport type MockRoute = \"absent\" | \"tag\" | \"stub\" | \"cached\" | \"child\";\n\n/**\n * The mock client's property route (testing.ts): `then`, Symbol.toPrimitive and Symbol.iterator\n * are absent (never a thenable or iterable), the toStringTag is the tag, a MockFn property\n * reaches the stub, a seen name its cached child, any other a new child.\n *\n * @ensures exactly the model's MockPropRoute\n */\nexport function mockPropRoute(\n isThen: boolean,\n isToPrimitive: boolean,\n isIterator: boolean,\n isToStringTag: boolean,\n isMockFnProp: boolean,\n isCached: boolean,\n): MockRoute {\n //@ verify\n //@ ensures (isThen || isToPrimitive || isIterator) ==> \\result === \"absent\"\n //@ ensures !(isThen || isToPrimitive || isIterator) && isToStringTag ==> \\result === \"tag\"\n //@ ensures !(isThen || isToPrimitive || isIterator) && !isToStringTag && isMockFnProp ==> \\result === \"stub\"\n //@ ensures !(isThen || isToPrimitive || isIterator) && !isToStringTag && !isMockFnProp && isCached ==> \\result === \"cached\"\n //@ ensures !(isThen || isToPrimitive || isIterator) && !isToStringTag && !isMockFnProp && !isCached ==> \\result === \"child\"\n if (isThen || isToPrimitive || isIterator) return \"absent\";\n if (isToStringTag) return \"tag\";\n if (isMockFnProp) return \"stub\";\n return isCached ? \"cached\" : \"child\";\n}\n\n/** How a generated method calls executeRequest. */\nexport type RequestShape = \"withPathParams\" | \"paramsOnly\" | \"noParams\";\n\n/**\n * With its path params; else with its params alone when the endpoint declares query params or a\n * body was given; else bare.\n *\n * @ensures exactly the model's RequestShapeOf\n */\nexport function requestShapeOf(\n hasPathParams: boolean,\n hasQueryParams: boolean,\n hasBody: boolean,\n): RequestShape {\n //@ verify\n //@ ensures hasPathParams ==> \\result === \"withPathParams\"\n //@ ensures !hasPathParams && (hasQueryParams || hasBody) ==> \\result === \"paramsOnly\"\n //@ ensures !hasPathParams && !hasQueryParams && !hasBody ==> \\result === \"noParams\"\n if (hasPathParams) return \"withPathParams\";\n return hasQueryParams || hasBody ? \"paramsOnly\" : \"noParams\";\n}\n\n/**\n * A legacy key's value is copied to its camelCase name only when the caller did not give that\n * name too: the caller's camelCase value always wins.\n *\n * @ensures exactly the model's CopiesLegacyValue\n */\nexport function copiesLegacyValue(camelGiven: boolean): boolean {\n //@ verify\n //@ ensures \\result <==> !camelGiven\n return !camelGiven;\n}\n\n/**\n * The placeholders a typed method's path param fills (base-client.ts): the key's own `{key}`\n * when the path has it, else every placeholder matching it by folded name.\n *\n * @ensures exactly the model's PathParamTargets\n */\nexport function pathParamTargets(path: string, key: string): string[] {\n //@ verify\n //@ ensures includesFrom(path, braced(key), 0) ==> \\result.length === 1 && \\result[0] === key\n //@ ensures !includesFrom(path, braced(key), 0) ==> \\result === foldMatchesFrom(templateNames(path, 0), key, 0)\n if (includesFrom(path, braced(key), 0)) return [key];\n return foldMatchesFrom(templateNames(path, 0), key, 0);\n}\n\n/* The service proxy's decisions (service-proxy.ts), verified with LemmaScript → Dafny (model:\n models/AugurApi.dfy \"The service proxy\"; link: models/links/augur-api-core-proxy-rules.dfy).\n service-proxy.ts takes the arguments apart and asks these. */\n\n/**\n * The trailing-argument slot of the request body after the path params: none (-1) for a\n * DELETE, else the first (a GET's carries its query).\n *\n * @ensures exactly the model's BodySlot\n */\nexport function bodySlot(method: string): number {\n //@ verify\n //@ ensures \\result === (method === \"DELETE\" ? -1 : 0)\n return method === \"DELETE\" ? -1 : 0;\n}\n\n/**\n * The trailing-argument slot of the query: the second for a POST or PUT (after the body),\n * the first for a DELETE, none (-1) for a GET.\n *\n * @ensures exactly the model's QuerySlot\n */\nexport function querySlot(method: string): number {\n //@ verify\n //@ ensures \\result === (method === \"POST\" || method === \"PUT\" ? 1 : method === \"DELETE\" ? 0 : -1)\n if (method === \"POST\" || method === \"PUT\") return 1;\n return method === \"DELETE\" ? 0 : -1;\n}\n\n/**\n * A legacy snake_case key is renamed only when its camelCase form differs and is declared.\n *\n * @ensures exactly the model's LegacyAlias\n */\nexport function isLegacyAlias(changed: boolean, declared: boolean): boolean {\n //@ verify\n //@ ensures \\result <==> (changed && declared)\n return changed && declared;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;AC0DO,SAAS,cACd,QACA,eACA,YACA,eACA,cACA,UACW;AAOX,MAAI,UAAU,iBAAiB,WAAY,QAAO;AAClD,MAAI,cAAe,QAAO;AAC1B,MAAI,aAAc,QAAO;AACzB,SAAO,WAAW,WAAW;AAC/B;;;ADjBA,SAAS,eAAuB;AAC9B,MAAI,iBAA2D;AAE/D,QAAM,QAAmB;AAAA,IACvB,OAAO,CAAC;AAAA,IACR,SAAS,CAAC;AAAA,IACV,WAAW,CAAC;AAAA,IACZ,UAAU;AAAA,EACZ;AAEA,QAAM,KAAK,SAAS,UAAyB,MAA0B;AACrE,UAAM,MAAM,KAAK,IAAI;AACrB,UAAM,WAAW;AACjB,UAAM,UAAU,KAAK,IAAI;AAEzB,QAAI;AACF,YAAM,SAAS,iBAAiB,eAAe,GAAG,IAAI,IAAI;AAC1D,YAAM,QAAQ,KAAK,EAAE,MAAM,UAAU,OAAO,OAAO,CAAC;AACpD,aAAO;AAAA,IACT,SAAS,OAAgB;AACvB,YAAM,QAAQ,KAAK,EAAE,MAAM,SAAS,OAAO,MAAM,CAAC;AAClD,YAAM;AAAA,IACR;AAAA,EACF;AAEA,KAAG,OAAO;AAEV,KAAG,kBAAkB,CAAC,UAA2B;AAC/C,qBAAiB,MAAM;AACvB,WAAO;AAAA,EACT;AAEA,KAAG,oBAAoB,CAAC,UAA2B;AACjD,qBAAiB,MAAM,QAAQ,QAAQ,KAAK;AAC5C,WAAO;AAAA,EACT;AAEA,KAAG,oBAAoB,CAAC,UAA2B;AACjD,qBAAiB,MAAM,QAAQ,OAAO,KAAK;AAC3C,WAAO;AAAA,EACT;AAEA,KAAG,qBAAqB,CAAC,WAAoD;AAC3E,qBAAiB;AACjB,WAAO;AAAA,EACT;AAEA,KAAG,YAAY,MAAc;AAC3B,UAAM,QAAQ,CAAC;AACf,UAAM,UAAU,CAAC;AACjB,UAAM,YAAY,CAAC;AACnB,UAAM,WAAW;AACjB,qBAAiB;AACjB,WAAO;AAAA,EACT;AAEA,KAAG,YAAY,MAAc;AAC3B,UAAM,QAAQ,CAAC;AACf,UAAM,UAAU,CAAC;AACjB,UAAM,YAAY,CAAC;AACnB,UAAM,WAAW;AACjB,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGA,IAAM,gBAAgB,oBAAI,IAAI;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAQD,SAAS,kBAA2B;AAClC,QAAM,QAAQ,oBAAI,IAA8B;AAChD,MAAI;AACJ,QAAM,UAAU,MAAe,SAAS,aAAa;AAIrD,SAAO,IAAI,MAAM,SAAS,WAAW;AAAA,IACnC,IAAI,SAAiB,MAAgC;AAInD,YAAM,QAAQ;AAAA,QACZ,SAAS;AAAA,QACT,SAAS,OAAO;AAAA,QAChB,SAAS,OAAO;AAAA,QAChB,SAAS,OAAO;AAAA,QAChB,OAAO,SAAS,YAAY,cAAc,IAAI,IAAI;AAAA,QAClD,MAAM,IAAI,IAAI;AAAA,MAChB;AACA,UAAI,UAAU,SAAU,QAAO;AAC/B,UAAI,UAAU,MAAO,QAAO;AAE5B,UAAI,UAAU;AACZ,eAAQ,QAAQ,EAAyC,IAAc;AACzE,UAAI,UAAU,SAAU,QAAO,MAAM,IAAI,IAAI;AAG7C,YAAM,QAAQ,gBAAgB;AAC9B,YAAM,IAAI,MAAM,KAAK;AACrB,aAAO;AAAA,IACT;AAAA,IAEA,MAAM,SAAiB,SAAkB,MAA0B;AACjE,aAAO,QAAQ,EAAE,MAAM,SAAS,IAAI;AAAA,IACtC;AAAA,EACF,CAAC;AACH;AA0BO,SAAS,mBAAqC;AACnD,QAAM,QAAQ,gBAAgB;AAE9B,SAAO;AAAA,IACL,QAAQ;AAAA,IACR,OAAO;AAAA,EACT;AACF;","names":[]}
|
package/dist/testing.mjs
CHANGED
|
@@ -1,3 +1,11 @@
|
|
|
1
|
+
// src/core/proxy-rules.ts
|
|
2
|
+
function mockPropRoute(isThen, isToPrimitive, isIterator, isToStringTag, isMockFnProp, isCached) {
|
|
3
|
+
if (isThen || isToPrimitive || isIterator) return "absent";
|
|
4
|
+
if (isToStringTag) return "tag";
|
|
5
|
+
if (isMockFnProp) return "stub";
|
|
6
|
+
return isCached ? "cached" : "child";
|
|
7
|
+
}
|
|
8
|
+
|
|
1
9
|
// src/testing.ts
|
|
2
10
|
function createStubFn() {
|
|
3
11
|
let implementation = null;
|
|
@@ -69,16 +77,19 @@ function createDeepProxy() {
|
|
|
69
77
|
const ownStub = () => stub ??= createStubFn();
|
|
70
78
|
return new Proxy(Function.prototype, {
|
|
71
79
|
get(_target, prop) {
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
80
|
+
const route = mockPropRoute(
|
|
81
|
+
prop === "then",
|
|
82
|
+
prop === Symbol.toPrimitive,
|
|
83
|
+
prop === Symbol.iterator,
|
|
84
|
+
prop === Symbol.toStringTag,
|
|
85
|
+
typeof prop === "string" && MOCK_FN_PROPS.has(prop),
|
|
86
|
+
cache.has(prop)
|
|
87
|
+
);
|
|
88
|
+
if (route === "absent") return void 0;
|
|
89
|
+
if (route === "tag") return "MockProxy";
|
|
90
|
+
if (route === "stub")
|
|
77
91
|
return ownStub()[prop];
|
|
78
|
-
|
|
79
|
-
if (cache.has(prop)) {
|
|
80
|
-
return cache.get(prop);
|
|
81
|
-
}
|
|
92
|
+
if (route === "cached") return cache.get(prop);
|
|
82
93
|
const child = createDeepProxy();
|
|
83
94
|
cache.set(prop, child);
|
|
84
95
|
return child;
|
package/dist/testing.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/testing.ts"],"sourcesContent":["/**\n * Testing utilities for @simpleapps-com/augur-api\n *\n * Provides a Proxy-based deep mock factory that automatically creates\n * mock functions at any depth, matching the AugurAPI client shape.\n *\n * @example\n * ```typescript\n * import { createMockClient } from '@simpleapps-com/augur-api/testing';\n *\n * const { client, mocks } = createMockClient();\n * mocks.commerce.cartHeaders.lookup.mockResolvedValue({ data: [] });\n *\n * const result = await client.commerce.cartHeaders.lookup({ userId: 1 });\n * expect(mocks.commerce.cartHeaders.lookup.mock.calls[0]).toEqual([{ userId: 1 }]);\n * ```\n */\n\nimport type { AugurAPI } from \"./client\";\n\n/** Recorded call arguments */\nexport interface MockCall {\n args: unknown[];\n timestamp: number;\n}\n\n/** Call tracking state */\nexport interface MockState {\n calls: unknown[][];\n results: Array<{ type: \"return\" | \"throw\"; value: unknown }>;\n instances: unknown[];\n lastCall: unknown[] | undefined;\n}\n\n/** A mock function with call tracking and return-value control */\nexport interface MockFn {\n (...args: unknown[]): unknown;\n mock: MockState;\n mockReturnValue(value: unknown): MockFn;\n mockResolvedValue(value: unknown): MockFn;\n mockRejectedValue(value: unknown): MockFn;\n mockImplementation(fn: (...args: unknown[]) => unknown): MockFn;\n mockReset(): MockFn;\n mockClear(): MockFn;\n}\n\n/** Recursively maps AugurAPI to MockFn leaves */\nexport type DeepMockClient<T> = {\n [K in keyof T]: T[K] extends (...args: never[]) => unknown ? MockFn : DeepMockClient<T[K]>;\n};\n\n/** Return type of createMockClient */\nexport interface MockClientResult {\n client: AugurAPI;\n mocks: DeepMockClient<AugurAPI>;\n}\n\n/** Create a stub function with full call-tracking */\nfunction createStubFn(): MockFn {\n let implementation: ((...args: unknown[]) => unknown) | null = null;\n\n const state: MockState = {\n calls: [],\n results: [],\n instances: [],\n lastCall: undefined,\n };\n\n const fn = function mockFn(this: unknown, ...args: unknown[]): unknown {\n state.calls.push(args);\n state.lastCall = args;\n state.instances.push(this);\n\n try {\n const result = implementation ? implementation(...args) : undefined;\n state.results.push({ type: \"return\", value: result });\n return result;\n } catch (error: unknown) {\n state.results.push({ type: \"throw\", value: error });\n throw error;\n }\n } as MockFn;\n\n fn.mock = state;\n\n fn.mockReturnValue = (value: unknown): MockFn => {\n implementation = () => value;\n return fn;\n };\n\n fn.mockResolvedValue = (value: unknown): MockFn => {\n implementation = () => Promise.resolve(value);\n return fn;\n };\n\n fn.mockRejectedValue = (value: unknown): MockFn => {\n implementation = () => Promise.reject(value);\n return fn;\n };\n\n fn.mockImplementation = (implFn: (...args: unknown[]) => unknown): MockFn => {\n implementation = implFn;\n return fn;\n };\n\n fn.mockReset = (): MockFn => {\n state.calls = [];\n state.results = [];\n state.instances = [];\n state.lastCall = undefined;\n implementation = null;\n return fn;\n };\n\n fn.mockClear = (): MockFn => {\n state.calls = [];\n state.results = [];\n state.instances = [];\n state.lastCall = undefined;\n return fn;\n };\n\n return fn;\n}\n\n/** Property names that belong to MockFn — triggers stub creation */\nconst MOCK_FN_PROPS = new Set([\n \"mock\",\n \"mockReturnValue\",\n \"mockResolvedValue\",\n \"mockRejectedValue\",\n \"mockImplementation\",\n \"mockReset\",\n \"mockClear\",\n]);\n\n/**\n * Create a recursive Proxy that lazily materializes MockFn stubs at any property access\n * depth. Each proxy holds its own stub: a chain always reaches the same cached child proxy,\n * so `mocks.a.b` and `client.a.b` share one stub with no path key (a key built from the\n * path was only ever compared with itself, so no test could see it).\n */\nfunction createDeepProxy(): unknown {\n const cache = new Map<string | symbol, unknown>();\n let stub: MockFn | undefined;\n const ownStub = (): MockFn => (stub ??= createStubFn());\n\n // The target only has to be callable so the `apply` trap fires; calls never\n // reach it. Function.prototype is callable and adds no uncovered code.\n return new Proxy(Function.prototype, {\n get(_target: object, prop: string | symbol): unknown {\n // Prevent spurious thenable detection (await/Promise.resolve)\n if (prop === \"then\") return undefined;\n\n // Support typeof checks\n if (prop === Symbol.toPrimitive) return undefined;\n if (prop === Symbol.iterator) return undefined;\n if (prop === Symbol.toStringTag) return \"MockProxy\";\n\n // MockFn property access — create stub eagerly and delegate\n if (typeof prop === \"string\" && MOCK_FN_PROPS.has(prop)) {\n return (ownStub() as unknown as Record<string, unknown>)[prop];\n }\n\n // Return cached child proxy\n if (cache.has(prop)) {\n return cache.get(prop);\n }\n\n // Create child proxy for the next level\n const child = createDeepProxy();\n cache.set(prop, child);\n return child;\n },\n\n apply(_target: object, thisArg: unknown, args: unknown[]): unknown {\n return ownStub().apply(thisArg, args);\n },\n });\n}\n\n/**\n * Create a fully-mocked AugurAPI client.\n *\n * Every property chain resolves to either a nested namespace or a callable\n * MockFn. The same object serves as both `client` (passed to production code)\n * and `mocks` (used in assertions).\n *\n * @returns `{ client, mocks }` — same object, dual-typed for ergonomics\n *\n * @example\n * ```typescript\n * const { client, mocks } = createMockClient();\n *\n * // Stub a return value\n * mocks.items.products.get.mockResolvedValue({ data: { id: 1 } });\n *\n * // Call through the client\n * const result = await client.items.products.get(1);\n *\n * // Assert\n * expect(mocks.items.products.get.mock.calls).toHaveLength(1);\n * expect(mocks.items.products.get.mock.calls[0]).toEqual([1]);\n * ```\n */\nexport function createMockClient(): MockClientResult {\n const proxy = createDeepProxy();\n\n return {\n client: proxy as unknown as AugurAPI,\n mocks: proxy as unknown as DeepMockClient<AugurAPI>,\n };\n}\n"],"mappings":";AA0DA,SAAS,eAAuB;AAC9B,MAAI,iBAA2D;AAE/D,QAAM,QAAmB;AAAA,IACvB,OAAO,CAAC;AAAA,IACR,SAAS,CAAC;AAAA,IACV,WAAW,CAAC;AAAA,IACZ,UAAU;AAAA,EACZ;AAEA,QAAM,KAAK,SAAS,UAAyB,MAA0B;AACrE,UAAM,MAAM,KAAK,IAAI;AACrB,UAAM,WAAW;AACjB,UAAM,UAAU,KAAK,IAAI;AAEzB,QAAI;AACF,YAAM,SAAS,iBAAiB,eAAe,GAAG,IAAI,IAAI;AAC1D,YAAM,QAAQ,KAAK,EAAE,MAAM,UAAU,OAAO,OAAO,CAAC;AACpD,aAAO;AAAA,IACT,SAAS,OAAgB;AACvB,YAAM,QAAQ,KAAK,EAAE,MAAM,SAAS,OAAO,MAAM,CAAC;AAClD,YAAM;AAAA,IACR;AAAA,EACF;AAEA,KAAG,OAAO;AAEV,KAAG,kBAAkB,CAAC,UAA2B;AAC/C,qBAAiB,MAAM;AACvB,WAAO;AAAA,EACT;AAEA,KAAG,oBAAoB,CAAC,UAA2B;AACjD,qBAAiB,MAAM,QAAQ,QAAQ,KAAK;AAC5C,WAAO;AAAA,EACT;AAEA,KAAG,oBAAoB,CAAC,UAA2B;AACjD,qBAAiB,MAAM,QAAQ,OAAO,KAAK;AAC3C,WAAO;AAAA,EACT;AAEA,KAAG,qBAAqB,CAAC,WAAoD;AAC3E,qBAAiB;AACjB,WAAO;AAAA,EACT;AAEA,KAAG,YAAY,MAAc;AAC3B,UAAM,QAAQ,CAAC;AACf,UAAM,UAAU,CAAC;AACjB,UAAM,YAAY,CAAC;AACnB,UAAM,WAAW;AACjB,qBAAiB;AACjB,WAAO;AAAA,EACT;AAEA,KAAG,YAAY,MAAc;AAC3B,UAAM,QAAQ,CAAC;AACf,UAAM,UAAU,CAAC;AACjB,UAAM,YAAY,CAAC;AACnB,UAAM,WAAW;AACjB,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGA,IAAM,gBAAgB,oBAAI,IAAI;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAQD,SAAS,kBAA2B;AAClC,QAAM,QAAQ,oBAAI,IAA8B;AAChD,MAAI;AACJ,QAAM,UAAU,MAAe,SAAS,aAAa;AAIrD,SAAO,IAAI,MAAM,SAAS,WAAW;AAAA,IACnC,IAAI,SAAiB,MAAgC;AAEnD,UAAI,SAAS,OAAQ,QAAO;AAG5B,UAAI,SAAS,OAAO,YAAa,QAAO;AACxC,UAAI,SAAS,OAAO,SAAU,QAAO;AACrC,UAAI,SAAS,OAAO,YAAa,QAAO;AAGxC,UAAI,OAAO,SAAS,YAAY,cAAc,IAAI,IAAI,GAAG;AACvD,eAAQ,QAAQ,EAAyC,IAAI;AAAA,MAC/D;AAGA,UAAI,MAAM,IAAI,IAAI,GAAG;AACnB,eAAO,MAAM,IAAI,IAAI;AAAA,MACvB;AAGA,YAAM,QAAQ,gBAAgB;AAC9B,YAAM,IAAI,MAAM,KAAK;AACrB,aAAO;AAAA,IACT;AAAA,IAEA,MAAM,SAAiB,SAAkB,MAA0B;AACjE,aAAO,QAAQ,EAAE,MAAM,SAAS,IAAI;AAAA,IACtC;AAAA,EACF,CAAC;AACH;AA0BO,SAAS,mBAAqC;AACnD,QAAM,QAAQ,gBAAgB;AAE9B,SAAO;AAAA,IACL,QAAQ;AAAA,IACR,OAAO;AAAA,EACT;AACF;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../src/core/proxy-rules.ts","../src/testing.ts"],"sourcesContent":["//@ backend dafny\nimport { foldMatchesFrom } from \"@atlas/utils/case\";\nimport { includesFrom } from \"@atlas/utils/includes\";\nimport { braced, templateNames } from \"@atlas/utils/uri\";\n\n/* How many leading arguments fill a method's path params (as many as both have: utils distance\n `min2`) and the folded-name match (utils case `foldMatchesFrom`) are `@atlas/utils`' since\n 2026-11-10. */\n\n/**\n * Legacy snake_case keys are renamed in a GET's query only: a POST or PUT body goes as given.\n *\n * @ensures exactly the model's RenamesWireParams\n */\nexport function renamesWireParams(method: string): boolean {\n //@ verify\n //@ ensures \\result <==> method === \"GET\"\n return method === \"GET\";\n}\n\n/**\n * An endpoint with no query params gets {} for a missing body (the hand-written `get` pattern).\n *\n * @ensures exactly the model's DefaultsEmptyBody\n */\nexport function defaultsEmptyBody(hasQueryParams: boolean, hasBody: boolean): boolean {\n //@ verify\n //@ ensures \\result <==> (!hasQueryParams && !hasBody)\n return !hasQueryParams && !hasBody;\n}\n\n/** What a data proxy does with a property. */\nexport type DataRoute = \"unwrap\" | \"nest\" | \"copy\";\n\n/**\n * A data proxy unwraps a method's answer to its data, nests an object, and copies the rest.\n *\n * @ensures exactly the model's DataProxyRoute\n */\nexport function dataProxyRoute(isFunction: boolean, isObject: boolean): DataRoute {\n //@ verify\n //@ ensures isFunction ==> \\result === \"unwrap\"\n //@ ensures !isFunction && isObject ==> \\result === \"nest\"\n //@ ensures !isFunction && !isObject ==> \\result === \"copy\"\n if (isFunction) return \"unwrap\";\n return isObject ? \"nest\" : \"copy\";\n}\n\n/** Where the mock client sends a property. */\nexport type MockRoute = \"absent\" | \"tag\" | \"stub\" | \"cached\" | \"child\";\n\n/**\n * The mock client's property route (testing.ts): `then`, Symbol.toPrimitive and Symbol.iterator\n * are absent (never a thenable or iterable), the toStringTag is the tag, a MockFn property\n * reaches the stub, a seen name its cached child, any other a new child.\n *\n * @ensures exactly the model's MockPropRoute\n */\nexport function mockPropRoute(\n isThen: boolean,\n isToPrimitive: boolean,\n isIterator: boolean,\n isToStringTag: boolean,\n isMockFnProp: boolean,\n isCached: boolean,\n): MockRoute {\n //@ verify\n //@ ensures (isThen || isToPrimitive || isIterator) ==> \\result === \"absent\"\n //@ ensures !(isThen || isToPrimitive || isIterator) && isToStringTag ==> \\result === \"tag\"\n //@ ensures !(isThen || isToPrimitive || isIterator) && !isToStringTag && isMockFnProp ==> \\result === \"stub\"\n //@ ensures !(isThen || isToPrimitive || isIterator) && !isToStringTag && !isMockFnProp && isCached ==> \\result === \"cached\"\n //@ ensures !(isThen || isToPrimitive || isIterator) && !isToStringTag && !isMockFnProp && !isCached ==> \\result === \"child\"\n if (isThen || isToPrimitive || isIterator) return \"absent\";\n if (isToStringTag) return \"tag\";\n if (isMockFnProp) return \"stub\";\n return isCached ? \"cached\" : \"child\";\n}\n\n/** How a generated method calls executeRequest. */\nexport type RequestShape = \"withPathParams\" | \"paramsOnly\" | \"noParams\";\n\n/**\n * With its path params; else with its params alone when the endpoint declares query params or a\n * body was given; else bare.\n *\n * @ensures exactly the model's RequestShapeOf\n */\nexport function requestShapeOf(\n hasPathParams: boolean,\n hasQueryParams: boolean,\n hasBody: boolean,\n): RequestShape {\n //@ verify\n //@ ensures hasPathParams ==> \\result === \"withPathParams\"\n //@ ensures !hasPathParams && (hasQueryParams || hasBody) ==> \\result === \"paramsOnly\"\n //@ ensures !hasPathParams && !hasQueryParams && !hasBody ==> \\result === \"noParams\"\n if (hasPathParams) return \"withPathParams\";\n return hasQueryParams || hasBody ? \"paramsOnly\" : \"noParams\";\n}\n\n/**\n * A legacy key's value is copied to its camelCase name only when the caller did not give that\n * name too: the caller's camelCase value always wins.\n *\n * @ensures exactly the model's CopiesLegacyValue\n */\nexport function copiesLegacyValue(camelGiven: boolean): boolean {\n //@ verify\n //@ ensures \\result <==> !camelGiven\n return !camelGiven;\n}\n\n/**\n * The placeholders a typed method's path param fills (base-client.ts): the key's own `{key}`\n * when the path has it, else every placeholder matching it by folded name.\n *\n * @ensures exactly the model's PathParamTargets\n */\nexport function pathParamTargets(path: string, key: string): string[] {\n //@ verify\n //@ ensures includesFrom(path, braced(key), 0) ==> \\result.length === 1 && \\result[0] === key\n //@ ensures !includesFrom(path, braced(key), 0) ==> \\result === foldMatchesFrom(templateNames(path, 0), key, 0)\n if (includesFrom(path, braced(key), 0)) return [key];\n return foldMatchesFrom(templateNames(path, 0), key, 0);\n}\n\n/* The service proxy's decisions (service-proxy.ts), verified with LemmaScript → Dafny (model:\n models/AugurApi.dfy \"The service proxy\"; link: models/links/augur-api-core-proxy-rules.dfy).\n service-proxy.ts takes the arguments apart and asks these. */\n\n/**\n * The trailing-argument slot of the request body after the path params: none (-1) for a\n * DELETE, else the first (a GET's carries its query).\n *\n * @ensures exactly the model's BodySlot\n */\nexport function bodySlot(method: string): number {\n //@ verify\n //@ ensures \\result === (method === \"DELETE\" ? -1 : 0)\n return method === \"DELETE\" ? -1 : 0;\n}\n\n/**\n * The trailing-argument slot of the query: the second for a POST or PUT (after the body),\n * the first for a DELETE, none (-1) for a GET.\n *\n * @ensures exactly the model's QuerySlot\n */\nexport function querySlot(method: string): number {\n //@ verify\n //@ ensures \\result === (method === \"POST\" || method === \"PUT\" ? 1 : method === \"DELETE\" ? 0 : -1)\n if (method === \"POST\" || method === \"PUT\") return 1;\n return method === \"DELETE\" ? 0 : -1;\n}\n\n/**\n * A legacy snake_case key is renamed only when its camelCase form differs and is declared.\n *\n * @ensures exactly the model's LegacyAlias\n */\nexport function isLegacyAlias(changed: boolean, declared: boolean): boolean {\n //@ verify\n //@ ensures \\result <==> (changed && declared)\n return changed && declared;\n}\n","/**\n * Testing utilities for @simpleapps-com/augur-api\n *\n * Provides a Proxy-based deep mock factory that automatically creates\n * mock functions at any depth, matching the AugurAPI client shape.\n *\n * @example\n * ```typescript\n * import { createMockClient } from '@simpleapps-com/augur-api/testing';\n *\n * const { client, mocks } = createMockClient();\n * mocks.commerce.cartHeaders.lookup.mockResolvedValue({ data: [] });\n *\n * const result = await client.commerce.cartHeaders.lookup({ userId: 1 });\n * expect(mocks.commerce.cartHeaders.lookup.mock.calls[0]).toEqual([{ userId: 1 }]);\n * ```\n */\n\nimport type { AugurAPI } from \"./client\";\nimport { mockPropRoute } from \"./core/proxy-rules\";\n\n/** Recorded call arguments */\nexport interface MockCall {\n args: unknown[];\n timestamp: number;\n}\n\n/** Call tracking state */\nexport interface MockState {\n calls: unknown[][];\n results: Array<{ type: \"return\" | \"throw\"; value: unknown }>;\n instances: unknown[];\n lastCall: unknown[] | undefined;\n}\n\n/** A mock function with call tracking and return-value control */\nexport interface MockFn {\n (...args: unknown[]): unknown;\n mock: MockState;\n mockReturnValue(value: unknown): MockFn;\n mockResolvedValue(value: unknown): MockFn;\n mockRejectedValue(value: unknown): MockFn;\n mockImplementation(fn: (...args: unknown[]) => unknown): MockFn;\n mockReset(): MockFn;\n mockClear(): MockFn;\n}\n\n/** Recursively maps AugurAPI to MockFn leaves */\nexport type DeepMockClient<T> = {\n [K in keyof T]: T[K] extends (...args: never[]) => unknown ? MockFn : DeepMockClient<T[K]>;\n};\n\n/** Return type of createMockClient */\nexport interface MockClientResult {\n client: AugurAPI;\n mocks: DeepMockClient<AugurAPI>;\n}\n\n/** Create a stub function with full call-tracking */\nfunction createStubFn(): MockFn {\n let implementation: ((...args: unknown[]) => unknown) | null = null;\n\n const state: MockState = {\n calls: [],\n results: [],\n instances: [],\n lastCall: undefined,\n };\n\n const fn = function mockFn(this: unknown, ...args: unknown[]): unknown {\n state.calls.push(args);\n state.lastCall = args;\n state.instances.push(this);\n\n try {\n const result = implementation ? implementation(...args) : undefined;\n state.results.push({ type: \"return\", value: result });\n return result;\n } catch (error: unknown) {\n state.results.push({ type: \"throw\", value: error });\n throw error;\n }\n } as MockFn;\n\n fn.mock = state;\n\n fn.mockReturnValue = (value: unknown): MockFn => {\n implementation = () => value;\n return fn;\n };\n\n fn.mockResolvedValue = (value: unknown): MockFn => {\n implementation = () => Promise.resolve(value);\n return fn;\n };\n\n fn.mockRejectedValue = (value: unknown): MockFn => {\n implementation = () => Promise.reject(value);\n return fn;\n };\n\n fn.mockImplementation = (implFn: (...args: unknown[]) => unknown): MockFn => {\n implementation = implFn;\n return fn;\n };\n\n fn.mockReset = (): MockFn => {\n state.calls = [];\n state.results = [];\n state.instances = [];\n state.lastCall = undefined;\n implementation = null;\n return fn;\n };\n\n fn.mockClear = (): MockFn => {\n state.calls = [];\n state.results = [];\n state.instances = [];\n state.lastCall = undefined;\n return fn;\n };\n\n return fn;\n}\n\n/** Property names that belong to MockFn — triggers stub creation */\nconst MOCK_FN_PROPS = new Set([\n \"mock\",\n \"mockReturnValue\",\n \"mockResolvedValue\",\n \"mockRejectedValue\",\n \"mockImplementation\",\n \"mockReset\",\n \"mockClear\",\n]);\n\n/**\n * Create a recursive Proxy that lazily materializes MockFn stubs at any property access\n * depth. Each proxy holds its own stub: a chain always reaches the same cached child proxy,\n * so `mocks.a.b` and `client.a.b` share one stub with no path key (a key built from the\n * path was only ever compared with itself, so no test could see it).\n */\nfunction createDeepProxy(): unknown {\n const cache = new Map<string | symbol, unknown>();\n let stub: MockFn | undefined;\n const ownStub = (): MockFn => (stub ??= createStubFn());\n\n // The target only has to be callable so the `apply` trap fires; calls never\n // reach it. Function.prototype is callable and adds no uncovered code.\n return new Proxy(Function.prototype, {\n get(_target: object, prop: string | symbol): unknown {\n // The route is the proved mockPropRoute: `then` absent (never a thenable for await or\n // Promise.resolve), toPrimitive and iterator absent (typeof checks), the tag for\n // toStringTag, the stub for a MockFn property, the cached child for a seen name\n const route = mockPropRoute(\n prop === \"then\",\n prop === Symbol.toPrimitive,\n prop === Symbol.iterator,\n prop === Symbol.toStringTag,\n typeof prop === \"string\" && MOCK_FN_PROPS.has(prop),\n cache.has(prop),\n );\n if (route === \"absent\") return undefined;\n if (route === \"tag\") return \"MockProxy\";\n // A \"stub\" route is only ever a string prop (a MockFn property name)\n if (route === \"stub\")\n return (ownStub() as unknown as Record<string, unknown>)[prop as string];\n if (route === \"cached\") return cache.get(prop);\n\n // Create child proxy for the next level\n const child = createDeepProxy();\n cache.set(prop, child);\n return child;\n },\n\n apply(_target: object, thisArg: unknown, args: unknown[]): unknown {\n return ownStub().apply(thisArg, args);\n },\n });\n}\n\n/**\n * Create a fully-mocked AugurAPI client.\n *\n * Every property chain resolves to either a nested namespace or a callable\n * MockFn. The same object serves as both `client` (passed to production code)\n * and `mocks` (used in assertions).\n *\n * @returns `{ client, mocks }` — same object, dual-typed for ergonomics\n *\n * @example\n * ```typescript\n * const { client, mocks } = createMockClient();\n *\n * // Stub a return value\n * mocks.items.products.get.mockResolvedValue({ data: { id: 1 } });\n *\n * // Call through the client\n * const result = await client.items.products.get(1);\n *\n * // Assert\n * expect(mocks.items.products.get.mock.calls).toHaveLength(1);\n * expect(mocks.items.products.get.mock.calls[0]).toEqual([1]);\n * ```\n */\nexport function createMockClient(): MockClientResult {\n const proxy = createDeepProxy();\n\n return {\n client: proxy as unknown as AugurAPI,\n mocks: proxy as unknown as DeepMockClient<AugurAPI>,\n };\n}\n"],"mappings":";AA0DO,SAAS,cACd,QACA,eACA,YACA,eACA,cACA,UACW;AAOX,MAAI,UAAU,iBAAiB,WAAY,QAAO;AAClD,MAAI,cAAe,QAAO;AAC1B,MAAI,aAAc,QAAO;AACzB,SAAO,WAAW,WAAW;AAC/B;;;ACjBA,SAAS,eAAuB;AAC9B,MAAI,iBAA2D;AAE/D,QAAM,QAAmB;AAAA,IACvB,OAAO,CAAC;AAAA,IACR,SAAS,CAAC;AAAA,IACV,WAAW,CAAC;AAAA,IACZ,UAAU;AAAA,EACZ;AAEA,QAAM,KAAK,SAAS,UAAyB,MAA0B;AACrE,UAAM,MAAM,KAAK,IAAI;AACrB,UAAM,WAAW;AACjB,UAAM,UAAU,KAAK,IAAI;AAEzB,QAAI;AACF,YAAM,SAAS,iBAAiB,eAAe,GAAG,IAAI,IAAI;AAC1D,YAAM,QAAQ,KAAK,EAAE,MAAM,UAAU,OAAO,OAAO,CAAC;AACpD,aAAO;AAAA,IACT,SAAS,OAAgB;AACvB,YAAM,QAAQ,KAAK,EAAE,MAAM,SAAS,OAAO,MAAM,CAAC;AAClD,YAAM;AAAA,IACR;AAAA,EACF;AAEA,KAAG,OAAO;AAEV,KAAG,kBAAkB,CAAC,UAA2B;AAC/C,qBAAiB,MAAM;AACvB,WAAO;AAAA,EACT;AAEA,KAAG,oBAAoB,CAAC,UAA2B;AACjD,qBAAiB,MAAM,QAAQ,QAAQ,KAAK;AAC5C,WAAO;AAAA,EACT;AAEA,KAAG,oBAAoB,CAAC,UAA2B;AACjD,qBAAiB,MAAM,QAAQ,OAAO,KAAK;AAC3C,WAAO;AAAA,EACT;AAEA,KAAG,qBAAqB,CAAC,WAAoD;AAC3E,qBAAiB;AACjB,WAAO;AAAA,EACT;AAEA,KAAG,YAAY,MAAc;AAC3B,UAAM,QAAQ,CAAC;AACf,UAAM,UAAU,CAAC;AACjB,UAAM,YAAY,CAAC;AACnB,UAAM,WAAW;AACjB,qBAAiB;AACjB,WAAO;AAAA,EACT;AAEA,KAAG,YAAY,MAAc;AAC3B,UAAM,QAAQ,CAAC;AACf,UAAM,UAAU,CAAC;AACjB,UAAM,YAAY,CAAC;AACnB,UAAM,WAAW;AACjB,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGA,IAAM,gBAAgB,oBAAI,IAAI;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAQD,SAAS,kBAA2B;AAClC,QAAM,QAAQ,oBAAI,IAA8B;AAChD,MAAI;AACJ,QAAM,UAAU,MAAe,SAAS,aAAa;AAIrD,SAAO,IAAI,MAAM,SAAS,WAAW;AAAA,IACnC,IAAI,SAAiB,MAAgC;AAInD,YAAM,QAAQ;AAAA,QACZ,SAAS;AAAA,QACT,SAAS,OAAO;AAAA,QAChB,SAAS,OAAO;AAAA,QAChB,SAAS,OAAO;AAAA,QAChB,OAAO,SAAS,YAAY,cAAc,IAAI,IAAI;AAAA,QAClD,MAAM,IAAI,IAAI;AAAA,MAChB;AACA,UAAI,UAAU,SAAU,QAAO;AAC/B,UAAI,UAAU,MAAO,QAAO;AAE5B,UAAI,UAAU;AACZ,eAAQ,QAAQ,EAAyC,IAAc;AACzE,UAAI,UAAU,SAAU,QAAO,MAAM,IAAI,IAAI;AAG7C,YAAM,QAAQ,gBAAgB;AAC9B,YAAM,IAAI,MAAM,KAAK;AACrB,aAAO;AAAA,IACT;AAAA,IAEA,MAAM,SAAiB,SAAkB,MAA0B;AACjE,aAAO,QAAQ,EAAE,MAAM,SAAS,IAAI;AAAA,IACtC;AAAA,EACF,CAAC;AACH;AA0BO,SAAS,mBAAqC;AACnD,QAAM,QAAQ,gBAAgB;AAE9B,SAAO;AAAA,IACL,QAAQ;AAAA,IACR,OAAO;AAAA,EACT;AACF;","names":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cross-site-auth.d.ts","sourceRoot":"","sources":["../../src/utils/cross-site-auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"cross-site-auth.d.ts","sourceRoot":"","sources":["../../src/utils/cross-site-auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAIrC;;;;GAIG;AAEH;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,wBAAwB;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,iDAAiD;IACjD,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,4CAA4C;IAC5C,OAAO,EAAE,OAAO,CAAC;IACjB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kEAAkE;IAClE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qBAAqB;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+EAA+E;IAC/E,aAAa,CAAC,EAAE,QAAQ,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,uBAAuB,CAC3C,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,CA8D9B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,4BAA4B,CAAC,cAAc,EAAE,MAAM,IAE/D,cAAc,MAAM,EACpB,UAAU,MAAM,EAChB,UAAU,MAAM,KACf,OAAO,CAAC,mBAAmB,CAAC,CAQhC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@simpleapps-com/augur-api",
|
|
3
|
-
"version": "2026.11.
|
|
3
|
+
"version": "2026.11.5",
|
|
4
4
|
"description": "TypeScript client library for Augur microservices API endpoints",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"augur",
|
|
@@ -67,6 +67,7 @@
|
|
|
67
67
|
"build": "tsup && tsc -p tsconfig.build.json",
|
|
68
68
|
"lint": "eslint .",
|
|
69
69
|
"live:bounded": "tsx tests/e2e/bounded-calls.live.ts",
|
|
70
|
+
"live:edge": "tsx tests/e2e/edge-cache.live.ts",
|
|
70
71
|
"proofs": "lsc gen-check --backend=dafny && node ../../models/lsc-check.mjs",
|
|
71
72
|
"smoke:workerd": "node tests/workerd/smoke.mts",
|
|
72
73
|
"story": "tsx tests/e2e/stories/run-json-story.ts",
|