@ankhorage/data-sources 0.6.0 → 1.0.0

package/src/test-runner/index.ts

@@ -90,23 +90,17 @@ interface EndpointOperationSelection {
 
 export async function testEndpoint(input: EndpointTestInput): Promise<EndpointTestResult> {
   const built = await buildEndpointTestRequest(input);
-
-  if (!built.ok) return built;
-  if (input.dryRun === true) return built;
+  if (!built.ok || input.dryRun === true) return built;
 
   if (input.fetch === undefined) {
-    return {
-      ok: false,
-      request: built.request,
-      diagnostics: [
-        ...built.diagnostics,
-        createDiagnostic(
-          input,
-          'invalid-config',
-          'Endpoint test runner requires an injected fetch function.',
-        ),
-      ],
-    };
+    return failure(built.request, [
+      ...built.diagnostics,
+      createDiagnostic(
+        input,
+        'invalid-config',
+        'Endpoint test runner requires an injected fetch function.',
+      ),
+    ]);
   }
 
   try {
@@ -117,7 +111,6 @@ export async function testEndpoint(input: EndpointTestInput): Promise<EndpointTe
     });
     const responseDiagnostic = await createResponseDiagnostic(response);
     const diagnostics = [...built.diagnostics];
-
     if (!responseDiagnostic.ok) {
       diagnostics.push(
         createDiagnostic(
@@ -127,7 +120,6 @@ export async function testEndpoint(input: EndpointTestInput): Promise<EndpointTe
         ),
       );
     }
-
     return responseDiagnostic.ok
       ? {
           ok: true,
@@ -136,21 +128,12 @@ export async function testEndpoint(input: EndpointTestInput): Promise<EndpointTe
           data: responseDiagnostic.parsedBody,
           diagnostics,
         }
-      : {
-          ok: false,
-          request: built.request,
-          response: responseDiagnostic,
-          diagnostics,
-        };
+      : failure(built.request, diagnostics, responseDiagnostic);
   } catch (error) {
-    return {
-      ok: false,
-      request: built.request,
-      diagnostics: [
-        ...built.diagnostics,
-        createDiagnostic(input, 'network-error', createNetworkErrorMessage(error)),
-      ],
-    };
+    return failure(built.request, [
+      ...built.diagnostics,
+      createDiagnostic(input, 'network-error', createNetworkErrorMessage(error)),
+    ]);
   }
 }
 
@@ -159,12 +142,19 @@ export async function buildEndpointTestRequest(
 ): Promise<EndpointTestResult> {
   const selection = selectEndpointOperation(input);
   if (selection === undefined) {
-    return {
-      ok: false,
-      diagnostics: [
-        createDiagnostic(input, 'missing-operation', 'Endpoint or operation could not be found.'),
-      ],
-    };
+    return failure(undefined, [
+      createDiagnostic(input, 'missing-operation', 'Endpoint or operation could not be found.'),
+    ]);
+  }
+
+  if (selection.operation.protocol === 'database') {
+    return failure(undefined, [
+      createDiagnostic(
+        input,
+        'invalid-config',
+        'Database-backed generated API operations require an adapter executor and cannot be tested through the HTTP endpoint runner.',
+      ),
+    ]);
   }
 
   const diagnostics: DataSourceDiagnostic[] = [];
@@ -175,27 +165,15 @@ export async function buildEndpointTestRequest(
       : buildHttpRequest(input, selection, credential, diagnostics);
 
   if (request === undefined || diagnostics.some((diagnostic) => diagnostic.severity === 'error')) {
-    return {
-      ok: false,
-      request,
-      diagnostics,
-    };
+    return failure(request, diagnostics);
   }
-
-  return {
-    ok: true,
-    request,
-    diagnostics,
-  };
+  return { ok: true, request, diagnostics };
 }
 
 function selectEndpointOperation(input: EndpointTestInput): EndpointOperationSelection | undefined {
   const endpoint = input.dataSource.endpoints[input.endpointId];
   const operation = endpoint?.operations[input.operationId];
-
-  if (endpoint === undefined || operation === undefined) return undefined;
-
-  return { endpoint, operation };
+  return endpoint === undefined || operation === undefined ? undefined : { endpoint, operation };
 }
 
 async function resolveEndpointCredential(
@@ -203,34 +181,25 @@ async function resolveEndpointCredential(
   selection: EndpointOperationSelection,
   diagnostics: DataSourceDiagnostic[],
 ): Promise<EndpointTestCredential | undefined> {
-  const credentialRef =
+  const ref =
     selection.operation.credential ?? selection.endpoint.credential ?? input.dataSource.credential;
-
-  if (credentialRef === undefined) return undefined;
-
+  if (ref === undefined) return undefined;
   if (input.credentialResolver === undefined) {
     diagnostics.push(
-      createDiagnostic(
-        input,
-        'missing-credential',
-        `Credential '${credentialRef.id}' requires a resolver.`,
-      ),
+      createDiagnostic(input, 'missing-credential', `Credential '${ref.id}' requires a resolver.`),
     );
     return undefined;
   }
-
-  const credential = await input.credentialResolver(credentialRef);
-
+  const credential = await input.credentialResolver(ref);
   if (credential === undefined) {
     diagnostics.push(
       createDiagnostic(
         input,
         'missing-credential',
-        `Credential '${credentialRef.id}' could not be resolved.`,
+        `Credential '${ref.id}' could not be resolved.`,
       ),
     );
   }
-
   return credential;
 }
 
@@ -242,14 +211,12 @@ function buildHttpRequest(
 ): EndpointTestRequestDiagnostic | undefined {
   const baseUrl = getDataSourceBaseUrl(input.dataSource, selection.endpoint);
   const path = selection.operation.path ?? selection.endpoint.path;
-
-  if (baseUrl === undefined || baseUrl.trim().length === 0) {
+  if (!baseUrl) {
     diagnostics.push(
       createDiagnostic(input, 'invalid-config', 'HTTP endpoint requires a base URL.'),
     );
     return undefined;
   }
-
   if (path === undefined) {
     diagnostics.push(createDiagnostic(input, 'invalid-config', 'HTTP operation requires a path.'));
     return undefined;
@@ -257,23 +224,17 @@ function buildHttpRequest(
 
   const values = input.values ?? {};
   const parameters = selection.operation.request?.parameters ?? [];
-  const pathResult = interpolatePath(path, parameters, values, input, diagnostics);
+  const resolvedPath = interpolatePath(path, parameters, values, input, diagnostics);
   const query = collectQuery(parameters, values, credential?.query);
-  const url = appendQuery(joinUrl(baseUrl, pathResult), query);
   const body = createHttpBody(selection.operation, values);
-  const headers: Record<string, string> = {
-    ...(credential?.headers ?? {}),
-  };
-
-  if (body !== undefined) {
-    headers['content-type'] = headers['content-type'] ?? 'application/json';
-  }
+  const headers: Record<string, string> = { ...(credential?.headers ?? {}) };
+  if (body !== undefined) headers['content-type'] = headers['content-type'] ?? 'application/json';
 
   return {
     dataSourceId: input.dataSource.id,
     endpointId: input.endpointId,
     operationId: input.operationId,
-    url,
+    url: appendQuery(joinUrl(baseUrl, resolvedPath), query),
     method: selection.operation.method ?? 'GET',
     headers,
     body,
@@ -288,8 +249,7 @@ function buildGraphQlRequest(
   diagnostics: DataSourceDiagnostic[],
 ): EndpointTestRequestDiagnostic | undefined {
   const endpointUrl = getGraphQlEndpointUrl(input.dataSource, selection.endpoint);
-
-  if (endpointUrl === undefined || endpointUrl.trim().length === 0) {
+  if (!endpointUrl) {
     diagnostics.push(
       createDiagnostic(input, 'invalid-config', 'GraphQL endpoint requires an endpoint URL.'),
     );
@@ -299,7 +259,6 @@ function buildGraphQlRequest(
   const query =
     getStringMetadataValue(selection.operation.metadata, 'document') ??
     getStringValue(input.values, 'query');
-
   if (query === undefined) {
     diagnostics.push(
       createDiagnostic(input, 'invalid-config', 'GraphQL operation requires a query document.'),
@@ -308,41 +267,35 @@ function buildGraphQlRequest(
   }
 
   const variables = getRecordValue(input.values, 'variables');
-  const body = JSON.stringify({ query, variables: variables ?? {} });
-  const headers: Record<string, string> = {
-    ...(credential?.headers ?? {}),
-    'content-type': 'application/json',
-  };
-
   return {
     dataSourceId: input.dataSource.id,
     endpointId: input.endpointId,
     operationId: input.operationId,
     url: appendQuery(endpointUrl, credential?.query ?? {}),
     method: 'POST',
-    headers,
-    body,
+    headers: { ...(credential?.headers ?? {}), 'content-type': 'application/json' },
+    body: JSON.stringify({ query, variables: variables ?? {} }),
     dryRun: input.dryRun === true,
   };
 }
 
 function getDataSourceBaseUrl(
-  dataSource: DataSourceConfig,
+  source: DataSourceConfig,
   endpoint: DataEndpointConfig,
 ): string | undefined {
   if (endpoint.baseUrl !== undefined) return endpoint.baseUrl;
-  if (dataSource.kind === 'rest' || dataSource.kind === 'openapi') return dataSource.baseUrl;
-  if (dataSource.kind === 'graphql') return dataSource.endpointUrl;
-  return undefined;
+  if (source.kind !== 'api' || source.origin !== 'external') return undefined;
+  return source.protocol === 'rest' ? source.baseUrl : source.endpointUrl;
 }
 
 function getGraphQlEndpointUrl(
-  dataSource: DataSourceConfig,
+  source: DataSourceConfig,
   endpoint: DataEndpointConfig,
 ): string | undefined {
   if (endpoint.baseUrl !== undefined) return endpoint.baseUrl;
-  if (dataSource.kind === 'graphql') return dataSource.endpointUrl;
-  return undefined;
+  return source.kind === 'api' && source.origin === 'external' && source.protocol === 'graphql'
+    ? source.endpointUrl
+    : undefined;
 }
 
 function interpolatePath(
@@ -352,12 +305,9 @@ function interpolatePath(
   input: EndpointTestInput,
   diagnostics: DataSourceDiagnostic[],
 ): string {
-  let nextPath = path;
-  const pathParameters = parameters.filter((parameter) => parameter.location === 'path');
-
-  for (const parameter of pathParameters) {
+  let next = path;
+  for (const parameter of parameters.filter((item) => item.location === 'path')) {
     const value = values[parameter.name] ?? parameter.default;
-
     if (value === undefined) {
       diagnostics.push(
         createDiagnostic(
@@ -368,13 +318,12 @@ function interpolatePath(
       );
       continue;
     }
-
-    const encodedValue = encodeURIComponent(serializeEndpointUrlValue(value));
-    nextPath = nextPath.replaceAll(`{${parameter.name}}`, encodedValue);
-    nextPath = nextPath.replaceAll(`:${parameter.name}`, encodedValue);
+    const encoded = encodeURIComponent(serializeEndpointUrlValue(value));
+    next = next
+      .replaceAll(`{${parameter.name}}`, encoded)
+      .replaceAll(`:${parameter.name}`, encoded);
   }
-
-  return nextPath;
+  return next;
 }
 
 function collectQuery(
@@ -383,14 +332,11 @@ function collectQuery(
   credentialQuery: EndpointTestInputValues | undefined,
 ): EndpointTestInputValues {
   const query: Record<string, DataContractValue> = { ...(credentialQuery ?? {}) };
-
   for (const parameter of parameters) {
     if (parameter.location !== 'query') continue;
-
     const value = values[parameter.name] ?? parameter.default;
     if (value !== undefined) query[parameter.name] = value;
   }
-
   return query;
 }
 
@@ -399,31 +345,24 @@ function createHttpBody(
   values: EndpointTestInputValues,
 ): string | undefined {
   if (operation.method === 'GET' || operation.method === 'HEAD') return undefined;
-
-  const { body } = values;
-  if (body === undefined) return undefined;
-
-  return JSON.stringify(body);
+  return values.body === undefined ? undefined : JSON.stringify(values.body);
 }
 
 async function createResponseDiagnostic(
   response: EndpointTestFetchResponse,
 ): Promise<EndpointTestResponseDiagnostic> {
   const bodyText = await response.text();
-  const parsedBody = parseResponseBody(bodyText);
-
   return {
     status: response.status,
     ok: response.status >= 200 && response.status < 300,
     headers: response.headers,
     bodyText,
-    parsedBody,
+    parsedBody: parseResponseBody(bodyText),
   };
 }
 
 function parseResponseBody(bodyText: string): DataContractValue | undefined {
   if (bodyText.trim().length === 0) return undefined;
-
   try {
     const parsed: unknown = JSON.parse(bodyText);
     return isDataContractValue(parsed) ? parsed : { raw: bodyText };
@@ -435,31 +374,26 @@ function parseResponseBody(bodyText: string): DataContractValue | undefined {
 function appendQuery(url: string, query: EndpointTestInputValues): string {
   const entries = Object.entries(query);
   if (entries.length === 0) return url;
-
   const search = entries
     .map(
       ([key, value]) =>
         `${encodeURIComponent(key)}=${encodeURIComponent(serializeEndpointUrlValue(value))}`,
     )
     .join('&');
-  const separator = url.includes('?') ? '&' : '?';
-
-  return `${url}${separator}${search}`;
+  return `${url}${url.includes('?') ? '&' : '?'}${search}`;
 }
 
 function serializeEndpointUrlValue(value: DataContractValue): string {
   if (typeof value === 'string') return value;
   if (typeof value === 'number' || typeof value === 'boolean') return value.toString();
   if (value === null) return '';
-
   return JSON.stringify(value);
 }
 
 function joinUrl(baseUrl: string, path: string): string {
-  const normalizedBase = baseUrl.endsWith('/') ? baseUrl.slice(0, -1) : baseUrl;
+  const normalizedBaseUrl = baseUrl.endsWith('/') ? baseUrl.slice(0, -1) : baseUrl;
   const normalizedPath = path.startsWith('/') ? path : `/${path}`;
-
-  return `${normalizedBase}${normalizedPath}`;
+  return `${normalizedBaseUrl}${normalizedPath}`;
 }
 
 function getStringValue(
@@ -483,7 +417,6 @@ function getStringMetadataValue(
   key: string,
 ): string | undefined {
   if (!isDataContractRecord(metadata)) return undefined;
-
   const value = metadata[key];
   return typeof value === 'string' ? value : undefined;
 }
@@ -503,25 +436,22 @@ function createDiagnostic(
   };
 }
 
+function failure(
+  request: EndpointTestRequestDiagnostic | undefined,
+  diagnostics: readonly DataSourceDiagnostic[],
+  response?: EndpointTestResponseDiagnostic,
+): EndpointTestResult {
+  return { ok: false, request, response, diagnostics };
+}
+
 function createNetworkErrorMessage(error: unknown): string {
-  if (error instanceof Error) return error.message;
-  return 'Endpoint test request failed.';
+  return error instanceof Error ? error.message : 'Endpoint test request failed.';
 }
 
 function isDataContractValue(value: unknown): value is DataContractValue {
-  if (
-    value === null ||
-    typeof value === 'string' ||
-    typeof value === 'number' ||
-    typeof value === 'boolean'
-  ) {
-    return true;
-  }
-
+  if (value === null || ['string', 'number', 'boolean'].includes(typeof value)) return true;
   if (Array.isArray(value)) return value.every(isDataContractValue);
-  if (typeof value !== 'object') return false;
-
-  return Object.values(value).every(isDataContractValue);
+  return typeof value === 'object' && Object.values(value).every(isDataContractValue);
 }
 
 function isDataContractRecord(

package/dist/managed-api/index.d.ts

@@ -1,30 +0,0 @@
-import type { AdapterRef, DataEndpointConfig, DataOperationConfig, DataSchema, DataSourceDiagnostic, DataSourceDiagnosticResult, ManagedApiDataSourceConfig, OperationId } from '@ankhorage/contracts/data';
-import type { DbCollectionDefinition } from '@ankhorage/contracts/db';
-export declare const MANAGED_API_CRUD_OPERATIONS: readonly ["list", "read", "create", "update", "delete"];
-export type ManagedApiCrudOperation = (typeof MANAGED_API_CRUD_OPERATIONS)[number];
-export interface ManagedApiOperationPolicyRef {
-    readonly id: string;
-    readonly operation?: string;
-}
-export interface ManagedApiGenerationResourceDefinition {
-    readonly name: string;
-    readonly collection: DbCollectionDefinition;
-    readonly operations?: readonly ManagedApiCrudOperation[];
-    readonly policies?: readonly ManagedApiOperationPolicyRef[];
-}
-export interface ManagedApiGenerationDefinition {
-    readonly id: string;
-    readonly adapter: AdapterRef;
-    readonly name?: string;
-    readonly description?: string;
-    readonly resources: readonly ManagedApiGenerationResourceDefinition[];
-}
-export declare function createManagedApiDataSource(definition: ManagedApiGenerationDefinition): DataSourceDiagnosticResult<ManagedApiDataSourceConfig>;
-export declare function validateManagedApiDefinition(definition: ManagedApiGenerationDefinition): readonly DataSourceDiagnostic[];
-export declare function normalizeManagedApiDataSource(definition: ManagedApiGenerationDefinition): ManagedApiDataSourceConfig;
-export declare function createManagedApiEndpoint(definition: ManagedApiGenerationDefinition, resource: ManagedApiGenerationResourceDefinition, operations?: readonly ManagedApiCrudOperation[]): DataEndpointConfig;
-export declare function createManagedApiOperation(definition: ManagedApiGenerationDefinition, resource: ManagedApiGenerationResourceDefinition, operation: ManagedApiCrudOperation): DataOperationConfig;
-export declare function getManagedApiOperations(resource: ManagedApiGenerationResourceDefinition): readonly ManagedApiCrudOperation[];
-export declare function createManagedApiOperationId(resourceName: string, operation: ManagedApiCrudOperation): OperationId;
-export declare function createManagedApiResourceSchema(collection: DbCollectionDefinition): DataSchema;
-//# sourceMappingURL=index.d.ts.map

package/dist/managed-api/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/managed-api/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EAEV,kBAAkB,EAClB,mBAAmB,EAGnB,UAAU,EACV,oBAAoB,EACpB,0BAA0B,EAC1B,0BAA0B,EAE1B,WAAW,EACZ,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EACV,sBAAsB,EAGvB,MAAM,yBAAyB,CAAC;AAEjC,eAAO,MAAM,2BAA2B,yDAA0D,CAAC;AAEnG,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,2BAA2B,CAAC,CAAC,MAAM,CAAC,CAAC;AAEnF,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,sCAAsC;IACrD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,sBAAsB,CAAC;IAC5C,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,uBAAuB,EAAE,CAAC;IACzD,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,4BAA4B,EAAE,CAAC;CAC7D;AAED,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,SAAS,EAAE,SAAS,sCAAsC,EAAE,CAAC;CACvE;AAED,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,8BAA8B,GACzC,0BAA0B,CAAC,0BAA0B,CAAC,CAWxD;AAED,wBAAgB,4BAA4B,CAC1C,UAAU,EAAE,8BAA8B,GACzC,SAAS,oBAAoB,EAAE,CAsDjC;AAED,wBAAgB,6BAA6B,CAC3C,UAAU,EAAE,8BAA8B,GACzC,0BAA0B,CA6B5B;AAED,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,8BAA8B,EAC1C,QAAQ,EAAE,sCAAsC,EAChD,UAAU,GAAE,SAAS,uBAAuB,EAAsC,GACjF,kBAAkB,CAmBpB;AAED,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,8BAA8B,EAC1C,QAAQ,EAAE,sCAAsC,EAChD,SAAS,EAAE,uBAAuB,GACjC,mBAAmB,CAsBrB;AAED,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,sCAAsC,GAC/C,SAAS,uBAAuB,EAAE,CAEpC;AAED,wBAAgB,2BAA2B,CACzC,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,uBAAuB,GACjC,WAAW,CAEb;AAED,wBAAgB,8BAA8B,CAAC,UAAU,EAAE,sBAAsB,GAAG,UAAU,CAe7F"}