@gscdump/contracts 3.5.0 → 3.6.0

package/dist/v1/bing-data.d.mts

@@ -1,6 +1,6 @@
 import { CompatibleResponseSchema } from "./http-core.mjs";
 import { z } from "zod";
-declare const bingDataQueryV1Schema: z.ZodObject<{
+export declare const bingDataQueryV1Schema: z.ZodObject<{
   dataset: z.ZodEnum<{
     keywords: "keywords";
     pages: "pages";
@@ -55,7 +55,7 @@ declare const pagination: CompatibleResponseSchema<z.ZodObject<{
   readonly offset: z.ZodNumber;
   readonly hasMore: z.ZodBoolean;
 }, z.core.$strip>>;
-declare const bingDataV1Schemas: {
+export declare const bingDataV1Schemas: {
   producer: z.ZodDiscriminatedUnion<[z.ZodObject<{
     searchEngine: z.ZodLiteral<"bing">;
     siteUrl: z.ZodURL;
@@ -191,6 +191,5 @@ declare const bingDataV1Schemas: {
     pagination: typeof pagination.producer;
   }, z.core.$strip>], "dataset">;
 };
-type BingDataV1 = z.infer<typeof bingDataV1Schemas.producer>;
-type BingDataQueryV1 = z.infer<typeof bingDataQueryV1Schema>;
-export { BingDataQueryV1, BingDataV1, bingDataQueryV1Schema, bingDataV1Schemas };
+export type BingDataV1 = z.infer<typeof bingDataV1Schemas.producer>;
+export type BingDataQueryV1 = z.infer<typeof bingDataQueryV1Schema>;

package/dist/v1/bing.d.mts

@@ -1,10 +1,10 @@
 import { z } from "zod";
-declare const bingCnameVerificationV1Schema: z.ZodObject<{
+export declare const bingCnameVerificationV1Schema: z.ZodObject<{
   _tag: z.ZodLiteral<"cname">;
   name: z.ZodString;
   value: z.ZodLiteral<"verify.bing.com">;
 }, z.core.$strict>;
-declare const bingConnectionV1Schema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+export declare const bingConnectionV1Schema: z.ZodDiscriminatedUnion<[z.ZodObject<{
   _tag: z.ZodLiteral<"disconnected">;
   searchEngine: z.ZodLiteral<"bing">;
 }, z.core.$strict>, z.ZodObject<{
@@ -43,6 +43,5 @@ declare const bingConnectionV1Schema: z.ZodDiscriminatedUnion<[z.ZodObject<{
   verified: z.ZodLiteral<true>;
   reason: z.ZodLiteral<"permission-lost">;
 }, z.core.$strict>], "_tag">;
-type BingCnameVerificationV1 = z.infer<typeof bingCnameVerificationV1Schema>;
-type BingConnectionV1 = z.infer<typeof bingConnectionV1Schema>;
-export { BingCnameVerificationV1, BingConnectionV1, bingCnameVerificationV1Schema, bingConnectionV1Schema };
+export type BingCnameVerificationV1 = z.infer<typeof bingCnameVerificationV1Schema>;
+export type BingConnectionV1 = z.infer<typeof bingConnectionV1Schema>;

package/dist/v1/browser.d.mts

@@ -1,7 +1,7 @@
 import { CompatibleResponseSchema } from "./http-core.mjs";
 import { RealtimeV1Schemas } from "./realtime.mjs";
 import { z } from "zod";
-interface NormalizedFilterV1 {
+export interface NormalizedFilterV1 {
   _filters: Array<{
     dimension: string;
     operator: string;
@@ -11,8 +11,8 @@ interface NormalizedFilterV1 {
   _nestedGroups?: NormalizedFilterV1[];
   _groupType?: 'and' | 'or';
 }
-declare const GSCDUMP_V1_ANALYTICS_DIMENSIONS: readonly ["page", "query", "queryCanonical", "country", "device", "date", "searchAppearance", "hour"];
-declare function createGscdumpV1BrowserSchemas(realtimeSchemas?: RealtimeV1Schemas): {
+export declare const GSCDUMP_V1_ANALYTICS_DIMENSIONS: readonly ["page", "query", "queryCanonical", "country", "device", "date", "searchAppearance", "hour"];
+export declare function createGscdumpV1BrowserSchemas(realtimeSchemas?: RealtimeV1Schemas): {
   analyticsRowsRequest: z.ZodObject<{
     dimensions: z.ZodArray<z.ZodEnum<{
       page: "page";
@@ -463,5 +463,4 @@ declare function createGscdumpV1BrowserSchemas(realtimeSchemas?: RealtimeV1Schem
       version: z.ZodLiteral<"1.0">;
     }, z.core.$loose>;
   }, z.core.$loose>;
-};
-export { GSCDUMP_V1_ANALYTICS_DIMENSIONS, NormalizedFilterV1, createGscdumpV1BrowserSchemas };
+};

package/dist/v1/documents.d.mts

@@ -1,4 +1,3 @@
-type ContractDocument = Record<string, unknown>;
-declare function serializeContractDocument(document: ContractDocument): string;
-declare function createGscdumpV1Documents(): Record<'openapi.partner.v1.json' | 'openapi.analytics.v1.json' | 'openapi.realtime.v1.json' | 'asyncapi.realtime.v1.json', ContractDocument>;
-export { ContractDocument, createGscdumpV1Documents, serializeContractDocument };
+export type ContractDocument = Record<string, unknown>;
+export declare function serializeContractDocument(document: ContractDocument): string;
+export declare function createGscdumpV1Documents(): Record<'openapi.partner.v1.json' | 'openapi.analytics.v1.json' | 'openapi.realtime.v1.json' | 'asyncapi.realtime.v1.json', ContractDocument>;

package/dist/v1/http-core.d.mts

@@ -3,45 +3,45 @@ import { HttpV1RouteSurfaceName } from "./route-surfaces.mjs";
 import { HttpV1RouteMethod } from "./route-catalog.mjs";
 import { GSCDUMP_HTTP_V1_VERSION } from "./version.mjs";
 import { ZodRawShape, ZodTypeAny, z } from "zod";
-declare const HTTP_V1_SURFACES: readonly ["partner", "analytics", "realtime"];
-declare const HTTP_V1_METHODS: readonly ["DELETE", "GET", "PATCH", "POST"];
-declare const HTTP_V1_CREDENTIALS: readonly ["user_key", "partner_key"];
-declare const HTTP_V1_SCOPES: readonly ["users:read", "users:write", "sites:read", "sites:write", "analytics:read", "analytics:execute", "indexing:read", "indexing:write", "sitemaps:read", "sitemaps:write", "settings:read", "settings:write", "realtime:connect", "teams:read", "teams:write"];
-declare const HTTP_V1_CREDENTIAL_SCOPES: {
+export declare const HTTP_V1_SURFACES: readonly ["partner", "analytics", "realtime"];
+export declare const HTTP_V1_METHODS: readonly ["DELETE", "GET", "PATCH", "POST"];
+export declare const HTTP_V1_CREDENTIALS: readonly ["user_key", "partner_key"];
+export declare const HTTP_V1_SCOPES: readonly ["users:read", "users:write", "sites:read", "sites:write", "analytics:read", "analytics:execute", "indexing:read", "indexing:write", "sitemaps:read", "sitemaps:write", "settings:read", "settings:write", "realtime:connect", "teams:read", "teams:write"];
+export declare const HTTP_V1_CREDENTIAL_SCOPES: {
   readonly user_key: readonly ["users:read", "users:write", "sites:read", "sites:write", "analytics:read", "analytics:execute", "indexing:read", "indexing:write", "sitemaps:read", "sitemaps:write", "settings:read", "settings:write", "realtime:connect"];
   readonly partner_key: readonly ["users:read", "users:write", "sites:read", "sites:write", "analytics:read", "analytics:execute", "indexing:read", "indexing:write", "sitemaps:read", "sitemaps:write", "settings:read", "settings:write", "realtime:connect", "teams:read", "teams:write"];
 };
-declare const HTTP_V1_ERROR_CODES: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "site_not_found", "rate_limited", "realtime_unavailable", "internal_error", "contract_violation"];
-type HttpV1SurfaceName = HttpV1RouteSurfaceName;
-type HttpV1Method = HttpV1RouteMethod;
-type HttpV1Credential = typeof HTTP_V1_CREDENTIALS[number];
-type HttpV1Scope = typeof HTTP_V1_SCOPES[number];
-type HttpV1ErrorCode = typeof HTTP_V1_ERROR_CODES[number];
-type HttpV1Visibility = 'internal' | 'public';
-type HttpV1OwnershipRule = 'self' | 'linked_user' | 'authorized_site' | 'partner_tenant' | 'principal_stream';
-type HttpV1ResourceType = 'partner.user' | 'partner.team' | 'user.sites' | 'site.registration' | 'site.lifecycle' | 'site.analytics' | 'site.sitemaps' | 'site.indexing' | 'site.auth';
-interface CompatibleResponseSchema<TProducer extends ZodTypeAny = ZodTypeAny, TClient extends ZodTypeAny = ZodTypeAny> {
+export declare const HTTP_V1_ERROR_CODES: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "site_not_found", "rate_limited", "realtime_unavailable", "internal_error", "contract_violation"];
+export type HttpV1SurfaceName = HttpV1RouteSurfaceName;
+export type HttpV1Method = HttpV1RouteMethod;
+export type HttpV1Credential = typeof HTTP_V1_CREDENTIALS[number];
+export type HttpV1Scope = typeof HTTP_V1_SCOPES[number];
+export type HttpV1ErrorCode = typeof HTTP_V1_ERROR_CODES[number];
+export type HttpV1Visibility = 'internal' | 'public';
+export type HttpV1OwnershipRule = 'self' | 'linked_user' | 'authorized_site' | 'partner_tenant' | 'principal_stream';
+export type HttpV1ResourceType = 'partner.user' | 'partner.team' | 'user.sites' | 'site.registration' | 'site.lifecycle' | 'site.analytics' | 'site.sitemaps' | 'site.indexing' | 'site.auth';
+export interface CompatibleResponseSchema<TProducer extends ZodTypeAny = ZodTypeAny, TClient extends ZodTypeAny = ZodTypeAny> {
   producer: TProducer;
   client: TClient;
 }
-interface HttpV1RequestSchemas {
+export interface HttpV1RequestSchemas {
   params: ZodTypeAny | null;
   query: ZodTypeAny | null;
   headers: ZodTypeAny | null;
   body: ZodTypeAny | null;
 }
-interface HttpV1Semantics {
+export interface HttpV1Semantics {
   kind: 'mutation' | 'query';
   sideEffects: 'none' | 'state';
   idempotent: boolean;
   retry: 'idempotent' | 'never';
   readConsistency: 'primary' | 'replica-ok' | null;
 }
-interface HttpV1ResourceReference {
+export interface HttpV1ResourceReference {
   type: HttpV1ResourceType;
   idFrom: `params.${string}` | 'principal.id';
 }
-interface HttpV1OperationDefinition {
+export interface HttpV1OperationDefinition {
   id: string;
   method: HttpV1Method;
   path: `/${string}`;
@@ -78,34 +78,34 @@ interface HttpV1OperationDefinition {
     };
   };
 }
-interface HttpV1Surface<TOperations extends Readonly<Record<string, HttpV1OperationDefinition>> = Readonly<Record<string, HttpV1OperationDefinition>>> {
+export interface HttpV1Surface<TOperations extends Readonly<Record<string, HttpV1OperationDefinition>> = Readonly<Record<string, HttpV1OperationDefinition>>> {
   name: HttpV1SurfaceName;
   prefix: `/api/${HttpV1SurfaceName}/v1`;
   version: '1.0';
   operations: TOperations;
 }
-interface HttpV1ProtocolLike {
+export interface HttpV1ProtocolLike {
   surfaces: Readonly<Record<string, HttpV1Surface>>;
 }
 type HttpV1ProtocolSurface<TProtocol extends HttpV1ProtocolLike> = TProtocol['surfaces'][keyof TProtocol['surfaces']];
 type HttpV1SurfaceOperation<TSurface> = TSurface extends HttpV1Surface<infer TOperations> ? TOperations[keyof TOperations] : never;
-type HttpV1ProtocolOperation<TProtocol extends HttpV1ProtocolLike> = HttpV1SurfaceOperation<HttpV1ProtocolSurface<TProtocol>>;
-type HttpV1OperationEntry<TProtocol extends HttpV1ProtocolLike = HttpV1ProtocolLike> = HttpV1ProtocolSurface<TProtocol> extends (infer TSurface) ? TSurface extends HttpV1Surface ? {
+export type HttpV1ProtocolOperation<TProtocol extends HttpV1ProtocolLike> = HttpV1SurfaceOperation<HttpV1ProtocolSurface<TProtocol>>;
+export type HttpV1OperationEntry<TProtocol extends HttpV1ProtocolLike = HttpV1ProtocolLike> = HttpV1ProtocolSurface<TProtocol> extends (infer TSurface) ? TSurface extends HttpV1Surface ? {
   surface: TSurface;
   operation: HttpV1SurfaceOperation<TSurface>;
 } : never : never;
-interface HttpV1OperationRequest {
+export interface HttpV1OperationRequest {
   method: string;
   surface: string;
   /** Surface-relative path without a leading slash or query string. */
   path: string;
 }
-type ResolvedHttpV1Operation<TEntry extends HttpV1OperationEntry = HttpV1OperationEntry> = TEntry & {
+export type ResolvedHttpV1Operation<TEntry extends HttpV1OperationEntry = HttpV1OperationEntry> = TEntry & {
   params: Record<string, unknown>;
   /** Canonical surface-relative path. */
   path: string;
 };
-type HttpV1RegistryOperationId<TProtocol extends HttpV1ProtocolLike> = HttpV1ProtocolOperation<TProtocol>['id'] & string;
+export type HttpV1RegistryOperationId<TProtocol extends HttpV1ProtocolLike> = HttpV1ProtocolOperation<TProtocol>['id'] & string;
 type HttpV1OperationEntryWithId<TEntry, TId extends string> = TEntry extends {
   surface: infer TSurface extends HttpV1Surface;
   operation: infer TOperation extends HttpV1OperationDefinition;
@@ -115,31 +115,31 @@ type HttpV1OperationEntryWithId<TEntry, TId extends string> = TEntry extends {
   surface: TSurface;
   operation: TOperation;
 } : never : never;
-type HttpV1RegistryOperationEntry<TProtocol extends HttpV1ProtocolLike, TId extends HttpV1RegistryOperationId<TProtocol>> = HttpV1OperationEntryWithId<HttpV1OperationEntry<TProtocol>, TId>;
-type HttpV1RegistryPathParams<TProtocol extends HttpV1ProtocolLike, TId extends HttpV1RegistryOperationId<TProtocol>> = HttpV1RegistryOperationEntry<TProtocol, TId>['operation']['request']['params'] extends (infer TParams) ? TParams extends ZodTypeAny ? z.input<TParams> : undefined : never;
-interface HttpV1RegistryPathOptions {
+export type HttpV1RegistryOperationEntry<TProtocol extends HttpV1ProtocolLike, TId extends HttpV1RegistryOperationId<TProtocol>> = HttpV1OperationEntryWithId<HttpV1OperationEntry<TProtocol>, TId>;
+export type HttpV1RegistryPathParams<TProtocol extends HttpV1ProtocolLike, TId extends HttpV1RegistryOperationId<TProtocol>> = HttpV1RegistryOperationEntry<TProtocol, TId>['operation']['request']['params'] extends (infer TParams) ? TParams extends ZodTypeAny ? z.input<TParams> : undefined : never;
+export interface HttpV1RegistryPathOptions {
   /** Root replacing the contract's `/api` segment. */
   apiRoot?: string;
 }
-interface HttpV1Registry<TProtocol extends HttpV1ProtocolLike> {
+export interface HttpV1Registry<TProtocol extends HttpV1ProtocolLike> {
   operation: <const TId extends HttpV1RegistryOperationId<TProtocol>>(id: TId) => HttpV1RegistryOperationEntry<TProtocol, TId>;
   resolve: <const TAllowed extends readonly HttpV1RegistryOperationId<TProtocol>[]>(request: HttpV1OperationRequest, options: {
     allow: TAllowed;
   }) => ResolvedHttpV1Operation<HttpV1RegistryOperationEntry<TProtocol, TAllowed[number]>> | null;
   path: <const TId extends HttpV1RegistryOperationId<TProtocol>>(id: TId, params?: HttpV1RegistryPathParams<TProtocol, TId>, options?: HttpV1RegistryPathOptions) => string;
 }
-declare function defineHttpOperation<const TOperation extends HttpV1OperationDefinition>(operation: TOperation): TOperation;
-declare function defineHttpSurface<const TOperations extends Readonly<Record<string, HttpV1OperationDefinition>>>(surface: HttpV1Surface<TOperations>): HttpV1Surface<TOperations>;
-declare function listHttpOperations<const TProtocol extends HttpV1ProtocolLike>(protocol: TProtocol): HttpV1OperationEntry<TProtocol>[];
-declare function defineResponseObject<const TProducerShape extends ZodRawShape, const TClientShape extends ZodRawShape = TProducerShape>(producerShape: TProducerShape, clientShape?: TClientShape): CompatibleResponseSchema<z.ZodObject<TProducerShape>, z.ZodObject<TClientShape>>;
-declare function defineSuccessResponse<const TDataProducer extends ZodTypeAny, const TDataClient extends ZodTypeAny, const TMetaProducer extends ZodTypeAny, const TMetaClient extends ZodTypeAny>(data: CompatibleResponseSchema<TDataProducer, TDataClient>, meta: CompatibleResponseSchema<TMetaProducer, TMetaClient>): CompatibleResponseSchema<z.ZodObject<{
+export declare function defineHttpOperation<const TOperation extends HttpV1OperationDefinition>(operation: TOperation): TOperation;
+export declare function defineHttpSurface<const TOperations extends Readonly<Record<string, HttpV1OperationDefinition>>>(surface: HttpV1Surface<TOperations>): HttpV1Surface<TOperations>;
+export declare function listHttpOperations<const TProtocol extends HttpV1ProtocolLike>(protocol: TProtocol): HttpV1OperationEntry<TProtocol>[];
+export declare function defineResponseObject<const TProducerShape extends ZodRawShape, const TClientShape extends ZodRawShape = TProducerShape>(producerShape: TProducerShape, clientShape?: TClientShape): CompatibleResponseSchema<z.ZodObject<TProducerShape>, z.ZodObject<TClientShape>>;
+export declare function defineSuccessResponse<const TDataProducer extends ZodTypeAny, const TDataClient extends ZodTypeAny, const TMetaProducer extends ZodTypeAny, const TMetaClient extends ZodTypeAny>(data: CompatibleResponseSchema<TDataProducer, TDataClient>, meta: CompatibleResponseSchema<TMetaProducer, TMetaClient>): CompatibleResponseSchema<z.ZodObject<{
   data: TDataProducer;
   meta: TMetaProducer;
 }>, z.ZodObject<{
   data: TDataClient;
   meta: TMetaClient;
 }>>;
-declare function buildHttpOperationPath(surface: HttpV1Surface, operation: HttpV1OperationDefinition, params?: unknown): string;
-declare function resolveHttpOperation<const TEntries extends readonly HttpV1OperationEntry[]>(entries: TEntries, request: HttpV1OperationRequest): ResolvedHttpV1Operation<TEntries[number]> | null;
-declare function createHttpV1Registry<const TProtocol extends HttpV1ProtocolLike>(protocol: TProtocol): HttpV1Registry<TProtocol>;
-export { CompatibleResponseSchema, GSCDUMP_HTTP_V1_VERSION, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, HttpV1Credential, HttpV1ErrorCode, HttpV1Method, HttpV1OperationDefinition, HttpV1OperationEntry, HttpV1OperationRequest, HttpV1OwnershipRule, HttpV1ProtocolLike, HttpV1ProtocolOperation, HttpV1Registry, HttpV1RegistryOperationEntry, HttpV1RegistryOperationId, HttpV1RegistryPathOptions, HttpV1RegistryPathParams, HttpV1RequestSchemas, HttpV1ResourceReference, HttpV1ResourceType, HttpV1Scope, HttpV1Semantics, HttpV1Surface, HttpV1SurfaceName, HttpV1Visibility, ResolvedHttpV1Operation, type UnknownHttpV1OperationError, buildHttpOperationPath, createHttpV1Registry, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse, isUnknownHttpV1OperationError, listHttpOperations, resolveHttpOperation };
+export declare function buildHttpOperationPath(surface: HttpV1Surface, operation: HttpV1OperationDefinition, params?: unknown): string;
+export declare function resolveHttpOperation<const TEntries extends readonly HttpV1OperationEntry[]>(entries: TEntries, request: HttpV1OperationRequest): ResolvedHttpV1Operation<TEntries[number]> | null;
+export declare function createHttpV1Registry<const TProtocol extends HttpV1ProtocolLike>(protocol: TProtocol): HttpV1Registry<TProtocol>;
+export { GSCDUMP_HTTP_V1_VERSION, type UnknownHttpV1OperationError, isUnknownHttpV1OperationError };

package/dist/v1/http-operation-error.d.mts

@@ -1,6 +1,5 @@
-interface UnknownHttpV1OperationError extends TypeError {
+export interface UnknownHttpV1OperationError extends TypeError {
   readonly tag: 'UnknownHttpV1OperationError';
   readonly operationId: string;
 }
-declare function isUnknownHttpV1OperationError(error: unknown): error is UnknownHttpV1OperationError;
-export { UnknownHttpV1OperationError, isUnknownHttpV1OperationError };
+export declare function isUnknownHttpV1OperationError(error: unknown): error is UnknownHttpV1OperationError;