@makeswift/runtime 0.28.7-canary.4 → 0.28.7-canary.5

package/dist/esm/client/component-snapshot.js

@@ -0,0 +1,39 @@
+import { EMBEDDED_DOCUMENT_TYPE } from "../state/modules/read-only-documents";
+import { deterministicUUID } from "../utils/deterministic-uuid";
+function componentDocumentToRootEmbeddedDocument({
+  document,
+  documentKey,
+  name,
+  type,
+  description,
+  meta
+}) {
+  const { data: rootElement, locale, id } = document;
+  if (rootElement != null && rootElement.type !== type) {
+    throw new Error(
+      `Type "${rootElement.type}" does not match the expected type "${type}" from the snapshot`
+    );
+  }
+  const rootDocument = {
+    key: documentKey,
+    rootElement: rootElement ?? {
+      // Fallback rootElement
+      // Create a stable uuid so two different clients will have the same empty element data.
+      // This is needed to make presence feature work for an element that is not yet created.
+      key: deterministicUUID({ id, locale, seed: documentKey }),
+      type,
+      props: {}
+    },
+    locale,
+    id,
+    type,
+    name,
+    meta: { ...meta, description },
+    __type: EMBEDDED_DOCUMENT_TYPE
+  };
+  return rootDocument;
+}
+export {
+  componentDocumentToRootEmbeddedDocument
+};
+//# sourceMappingURL=component-snapshot.js.map

package/dist/esm/client/component-snapshot.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/client/component-snapshot.ts"],"sourcesContent":["import { z } from 'zod'\n\nimport { type CacheData } from '../api/api-resources-client'\n\nimport { EMBEDDED_DOCUMENT_TYPE, type EmbeddedDocument } from '../state/modules/read-only-documents'\n\nimport { deterministicUUID } from '../utils/deterministic-uuid'\n\nimport * as Schema from './schema/component-document'\n\nexport type MakeswiftComponentDocument = z.infer<typeof Schema.componentDocument>\nexport type MakeswiftComponentDocumentFallback = z.infer<typeof Schema.componentDocumentFallback>\n\nexport type MakeswiftComponentMetadata = {\n  allowLocaleFallback: boolean\n  requestedLocale: string | null\n}\n\nexport function componentDocumentToRootEmbeddedDocument({\n  document,\n  documentKey,\n  name,\n  type,\n  description,\n  meta,\n}: {\n  document: MakeswiftComponentDocument | MakeswiftComponentDocumentFallback\n  documentKey: string\n  name: string\n  type: string\n  description?: string\n  meta: MakeswiftComponentMetadata\n}): EmbeddedDocument {\n  const { data: rootElement, locale, id } = document\n\n  if (rootElement != null && rootElement.type !== type) {\n    throw new Error(\n      `Type \"${rootElement.type}\" does not match the expected type \"${type}\" from the snapshot`,\n    )\n  }\n\n  const rootDocument: EmbeddedDocument = {\n    key: documentKey,\n    rootElement: rootElement ?? {\n      // Fallback rootElement\n      // Create a stable uuid so two different clients will have the same empty element data.\n      // This is needed to make presence feature work for an element that is not yet created.\n      key: deterministicUUID({ id, locale, seed: documentKey }),\n      type,\n      props: {},\n    },\n    locale,\n    id,\n    type,\n    name,\n    meta: { ...meta, description },\n    __type: EMBEDDED_DOCUMENT_TYPE,\n  }\n\n  return rootDocument\n}\n\nexport type MakeswiftComponentSnapshot = {\n  document: MakeswiftComponentDocument | MakeswiftComponentDocumentFallback\n  key: string\n  cacheData: CacheData\n  meta: MakeswiftComponentMetadata\n}\n"],"mappings":"AAIA,SAAS,8BAAqD;AAE9D,SAAS,yBAAyB;AAY3B,SAAS,wCAAwC;AAAA,EACtD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAOqB;AACnB,QAAM,EAAE,MAAM,aAAa,QAAQ,GAAG,IAAI;AAE1C,MAAI,eAAe,QAAQ,YAAY,SAAS,MAAM;AACpD,UAAM,IAAI;AAAA,MACR,SAAS,YAAY,IAAI,uCAAuC,IAAI;AAAA,IACtE;AAAA,EACF;AAEA,QAAM,eAAiC;AAAA,IACrC,KAAK;AAAA,IACL,aAAa,eAAe;AAAA;AAAA;AAAA;AAAA,MAI1B,KAAK,kBAAkB,EAAE,IAAI,QAAQ,MAAM,YAAY,CAAC;AAAA,MACxD;AAAA,MACA,OAAO,CAAC;AAAA,IACV;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,MAAM,EAAE,GAAG,MAAM,YAAY;AAAA,IAC7B,QAAQ;AAAA,EACV;AAEA,SAAO;AACT;","names":[]}

package/dist/esm/client/index.js

@@ -1,10 +1,9 @@
-import { z } from "zod";
 import {
   APIResourceType
-} from "../api";
-import { GraphQLClient } from "../api/graphql/client";
-import { FileQuery, IntrospectedResourcesQuery, TableQuery } from "../api/graphql/documents";
-import { CacheData } from "../api/client";
+} from "../api/types";
+import { CacheData } from "../api/api-resources-client";
+import { MakeswiftGraphQLApiClient } from "../api/graphql-api-client";
+import { MakeswiftRestAPIClient, failedResponseBody } from "../api/rest-api-client";
 import {
   getElementChildren,
   getSwatchIds,
@@ -17,223 +16,39 @@ import {
   getPropControllerDescriptors,
   isElementReference
 } from "../state/read-only-state";
-import { toIterablePaginationResult } from "../utils/pagination";
-import { deterministicUUID } from "../utils/deterministic-uuid";
-import { Schema } from "@makeswift/controls";
-import { EMBEDDED_DOCUMENT_TYPE } from "../state/modules/read-only-documents";
 import { mergeTranslatedContent } from "../state/translations/merge";
 import { getTranslatableContent } from "../state/translations/get";
+import { deterministicUUID } from "../utils/deterministic-uuid";
+import { toIterablePaginationResult } from "../utils/pagination";
 import { isNonNullable } from "../utils/isNonNullable";
-import { SnippetLocation as SnippetLocation2 } from "../api/graphql/generated/types";
-const makeswiftPageResultSchema = z.object({
-  id: z.string(),
-  path: z.string(),
-  title: z.string().nullable(),
-  description: z.string().nullable(),
-  canonicalUrl: z.string().nullable(),
-  socialImageUrl: z.string().nullable(),
-  sitemapPriority: z.number().nullable(),
-  sitemapFrequency: z.enum(["always", "hourly", "daily", "weekly", "monthly", "yearly", "never"]).nullable(),
-  createdAt: z.string(),
-  updatedAt: z.string(),
-  publishedAt: z.string().nullable(),
-  isOnline: z.boolean().nullable(),
-  excludedFromSearch: z.boolean().nullable(),
-  locale: z.string(),
-  localizedVariants: z.array(
-    z.object({
-      locale: z.string(),
-      path: z.string()
-    })
-  )
-});
-const makeswiftGetPagesResultAPISchema = z.object({
-  data: z.array(makeswiftPageResultSchema),
-  hasMore: z.boolean()
-});
-const makeswiftGetPagesParamsSchema = z.object({
-  limit: z.number().optional(),
-  after: z.string().optional(),
-  sortBy: z.enum(["title", "path", "description", "createdAt", "updatedAt"]).optional(),
-  sortDirection: z.enum(["asc", "desc"]).optional(),
-  includeOffline: z.boolean().optional(),
-  pathPrefix: z.string().optional(),
-  locale: z.string().optional()
-});
-function getPagesQueryParams({
-  limit = 100,
-  after,
-  sortBy,
-  sortDirection,
-  includeOffline,
-  pathPrefix,
-  locale
-}) {
-  const params = new URLSearchParams();
-  if (limit != null)
-    params.set("limit", limit.toString());
-  if (after != null)
-    params.set("after", after);
-  if (sortBy != null)
-    params.set("sortBy", sortBy);
-  if (sortDirection != null)
-    params.set("sortDirection", sortDirection);
-  if (includeOffline != null)
-    params.set("includeOffline", includeOffline.toString());
-  if (pathPrefix != null)
-    params.set("pathPrefix", pathPrefix);
-  if (locale != null)
-    params.set("locale", locale);
-  return params;
-}
-function pageToRootDocument(pageDocument) {
-  const { locale, localizedPages, id, data } = pageDocument;
-  const localizedPage = localizedPages.find(({ parentId }) => parentId == null);
-  return localizedPage ? { key: localizedPage.elementTreeId, rootElement: localizedPage.data, locale } : { key: id, rootElement: data, locale };
-}
-const makeswiftComponentDocumentSchema = z.object({
-  id: z.string(),
-  name: z.string().nullable(),
-  locale: z.string().nullable(),
-  data: Schema.element,
-  siteId: z.string(),
-  inheritsFromParent: z.boolean()
-});
-const makeswiftComponentDocumentFallbackSchema = z.object({
-  id: z.string(),
-  locale: z.string().nullable(),
-  data: z.null()
-});
-const previewTokenPayloadSchema = z.object({
-  payload: z.object({
-    version: z.string()
-  })
-});
-function componentDocumentToRootEmbeddedDocument({
-  document,
-  documentKey,
-  name,
-  type,
-  description,
-  meta
-}) {
-  const { data: rootElement, locale, id } = document;
-  if (rootElement != null && rootElement.type !== type) {
-    throw new Error(
-      `Type "${rootElement.type}" does not match the expected type "${type}" from the snapshot`
-    );
-  }
-  const rootDocument = {
-    key: documentKey,
-    rootElement: rootElement ?? {
-      // Fallback rootElement
-      // Create a stable uuid so two different clients will have the same empty element data.
-      // This is needed to make presence feature work for an element that is not yet created.
-      key: deterministicUUID({ id, locale, seed: documentKey }),
-      type,
-      props: {}
-    },
-    locale,
-    id,
-    type,
-    name,
-    meta: { ...meta, description },
-    __type: EMBEDDED_DOCUMENT_TYPE
-  };
-  return rootDocument;
-}
-async function failedResponseBody(response) {
-  try {
-    const text = await response.text();
-    try {
-      return JSON.parse(text);
-    } catch {
-      return text;
-    }
-  } catch (e) {
-    return `Failed to extract response body: ${e}`;
-  }
-}
-function responseError(response) {
-  return `${response.status} ${response.statusText}`;
-}
-const pagePathnameSlicesAPISchema = z.array(
-  z.object({
-    id: z.string(),
-    basePageId: z.string(),
-    pathname: z.string(),
-    localizedPathname: z.string().optional(),
-    __typename: z.literal("PagePathnameSlice")
-  }).nullable()
-);
-const getPageAPISchema = z.object({
-  pathname: z.string(),
-  locale: z.string(),
-  alternate: z.array(
-    z.object({
-      pathname: z.string(),
-      locale: z.string()
-    })
-  )
-});
-const getFontsAPISchema = z.object({
-  googleFonts: z.array(
-    z.object({
-      family: z.string(),
-      variants: z.array(z.string())
-    })
-  ),
-  siteId: z.string()
-});
-class MakeswiftClient {
+import * as Schema from "./schema";
+import { SnippetLocation } from "../api/graphql/generated/types";
+import {
+  componentDocumentToRootEmbeddedDocument
+} from "./component-snapshot";
+import {
+  pageToRootDocument
+} from "./page-snapshot";
+class MakeswiftClient extends MakeswiftRestAPIClient {
   graphqlClient;
   runtime;
-  apiKey;
-  constructor(apiKey, { runtime }) {
+  constructor(apiKey, {
+    runtime
+  }) {
     if (typeof apiKey !== "string") {
       throw new Error(
         `The Makeswift client must be passed a valid Makeswift site API key: \`new Makeswift('<makeswift_site_api_key>')\`
 Received "${apiKey}" instead.`
       );
     }
-    this.apiKey = apiKey;
-    this.graphqlClient = new GraphQLClient(new URL("graphql", runtime.apiOrigin).href, {
-      "makeswift-runtime-version": "0.28.7-canary.4"
-    });
-    this.runtime = runtime;
-  }
-  get apiOrigin() {
-    return this.runtime.apiOrigin;
-  }
-  async fetch(path, siteVersion, init) {
-    const requestUrl = new URL(path, this.apiOrigin);
-    const requestHeaders = new Headers({
-      "x-api-key": this.apiKey,
-      "makeswift-site-api-key": this.apiKey,
-      "makeswift-runtime-version": "0.28.7-canary.4"
+    super({
+      apiKey,
+      apiOrigin: runtime.apiOrigin
     });
-    if (siteVersion?.token) {
-      requestUrl.searchParams.set("version", siteVersion.version);
-      requestHeaders.set("makeswift-preview-token", siteVersion.token);
-    }
-    if (init?.headers) {
-      new Headers(init.headers).forEach((value, key) => {
-        requestHeaders.set(key, value);
-      });
-    }
-    const response = await fetch(requestUrl.toString(), {
-      ...init,
-      headers: requestHeaders,
-      ...siteVersion != null ? { cache: "no-store" } : {},
-      ...this.fetchOptions(siteVersion)
+    this.graphqlClient = new MakeswiftGraphQLApiClient({
+      endpoint: runtime.graphqlApiEndpoint
     });
-    return response;
-  }
-  /**
-   * Override this method to provide additional fetch options, e.g. revalidation, cache tags, etc.
-   */
-  fetchOptions(_siteVersion) {
-    return {};
+    this.runtime = runtime;
   }
   getPagesInternal = async ({
     siteVersion = null,
@@ -250,7 +65,7 @@ Received "${apiKey}" instead.`
       throw new Error(`Failed to get pages: ${responseError(response)}`);
     }
     const result = await response.json();
-    const parsedResponse = makeswiftGetPagesResultAPISchema.safeParse(result);
+    const parsedResponse = Schema.getPagesResult.safeParse(result);
     if (!parsedResponse.success) {
       throw new Error(
         `Failed to parse 'getPages' response: ${parsedResponse.error.errors.map((e) => e.message).join("; ")}`
@@ -276,7 +91,7 @@ Received "${apiKey}" instead.`
       throw new Error(`Failed to get page snapshot for '${pathname}': ${responseError(response)}`);
     }
     const json = await response.json();
-    return getPageAPISchema.parse(json);
+    return Schema.getPageResult.parse(json);
   }
   async getTypographies(typographyIds, siteVersion) {
     if (typographyIds.length === 0)
@@ -337,16 +152,16 @@ Received "${apiKey}" instead.`
     }
     const responseBody = await response.json();
     return responseBody.map(
-      (item) => item != null ? makeswiftComponentDocumentSchema.parse(item) : null
+      (item) => item != null ? Schema.componentDocument.parse(item) : null
     );
   }
   async getIntrospectedResources({
     swatchIds,
-    ...introspectedResourceIds
+    ...unversionedResourceIds
   }, siteVersion) {
-    const result = await this.graphqlClient.request(IntrospectedResourcesQuery, introspectedResourceIds);
+    const unversionedResources = await this.graphqlClient.getUnversionedResources(unversionedResourceIds);
     const swatches = await this.getSwatches(swatchIds, siteVersion);
-    return { ...result, swatches };
+    return { ...unversionedResources, swatches };
   }
   // TODO: Consolidate this method with the introspectMany method once the
   // unstable_getComponentSnapshots method is stable and tested in production.
@@ -751,7 +566,7 @@ Received "${apiKey}" instead.`
       });
       throw new Error(`Failed to get component snapshot for '${id}': ${responseError(response)}`);
     }
-    const document = makeswiftComponentDocumentSchema.parse(await response.json());
+    const document = Schema.componentDocument.parse(await response.json());
     const cacheData = await this.introspect(document.data, siteVersion, locale ?? null);
     return {
       document,
@@ -815,115 +630,11 @@ Received "${apiKey}" instead.`
       };
     });
   }
-  async getSwatch(swatchId, siteVersion) {
-    const response = await this.fetch(`v3/swatches/${swatchId}`, siteVersion);
-    if (!response.ok) {
-      const failedBody = await failedResponseBody(response);
-      if (response.status !== 404) {
-        console.error(`Failed to get swatch '${swatchId}'`, {
-          response: failedBody,
-          siteVersion
-        });
-      }
-      return null;
-    }
-    const swatch = await response.json();
-    return swatch;
-  }
   async getFile(fileId) {
-    const result = await this.graphqlClient.request(
-      FileQuery,
-      { fileId }
-    );
-    return result.file;
-  }
-  async getTypography(typographyId, siteVersion) {
-    const response = await this.fetch(`v3/typographies/${typographyId}`, siteVersion);
-    if (!response.ok) {
-      const failedBody = await failedResponseBody(response);
-      if (response.status !== 404) {
-        console.error(`Failed to get typography '${typographyId}'`, {
-          response: failedBody,
-          siteVersion
-        });
-      }
-      return null;
-    }
-    const typography = await response.json();
-    return typography;
-  }
-  async getGlobalElement(globalElementId, siteVersion) {
-    const response = await this.fetch(`v3/global-elements/${globalElementId}`, siteVersion);
-    if (!response.ok) {
-      const failedBody = await failedResponseBody(response);
-      if (response.status !== 404) {
-        console.error(`Failed to get global element '${globalElementId}'`, {
-          response: failedBody,
-          siteVersion
-        });
-      }
-      return null;
-    }
-    const globalElement = await response.json();
-    return globalElement;
-  }
-  async getLocalizedGlobalElement(globalElementId, locale, siteVersion) {
-    const response = await this.fetch(
-      `v3/localized-global-elements/${globalElementId}?locale=${locale}`,
-      siteVersion
-    );
-    if (!response.ok) {
-      const failedBody = await failedResponseBody(response);
-      if (response.status !== 404) {
-        console.error(`Failed to get localized global element '${globalElementId}'`, {
-          response: failedBody,
-          siteVersion,
-          locale
-        });
-      }
-      return null;
-    }
-    const localizedGlobalElement = await response.json();
-    return localizedGlobalElement;
-  }
-  async getPagePathnameSlices(pageIds, siteVersion, { locale }) {
-    if (pageIds.length === 0)
-      return [];
-    const url = new URL(`v3/page-pathname-slices/bulk`, this.apiOrigin);
-    pageIds.forEach((id) => url.searchParams.append("ids", id));
-    if (locale != null)
-      url.searchParams.set("locale", locale);
-    const response = await this.fetch(url.pathname + url.search, siteVersion);
-    if (!response.ok) {
-      console.error(`Failed to get page pathname slice(s) for ${pageIds.join(", ")}`, {
-        response: await failedResponseBody(response),
-        siteVersion,
-        locale
-      });
-      return [];
-    }
-    const json = await response.json();
-    const pagePathnameSlices = pagePathnameSlicesAPISchema.parse(json);
-    return pagePathnameSlices.map((pagePathnameSlice) => {
-      if (pagePathnameSlice == null)
-        return null;
-      return {
-        ...pagePathnameSlice,
-        id: pagePathnameSlice.basePageId,
-        localizedPathname: pagePathnameSlice.localizedPathname ?? null
-      };
-    });
-  }
-  async getPagePathnameSlice(pageId, siteVersion, { locale } = {}) {
-    const pagePathnameSlices = await this.getPagePathnameSlices([pageId], siteVersion, { locale });
-    return pagePathnameSlices.at(0) ?? null;
+    return this.graphqlClient.getFile(fileId);
   }
   async getTable(tableId) {
-    const result = await this.graphqlClient.request(
-      TableQuery,
-      { tableId }
-    );
-    return result.table;
+    return this.graphqlClient.getTable(tableId);
   }
   getTranslatableData(elementTree) {
     return getTranslatableContent(this.getElementDescriptors(), elementTree);
@@ -937,7 +648,7 @@ Received "${apiKey}" instead.`
       headers: {
         "x-api-key": this.apiKey,
         "makeswift-site-api-key": this.apiKey,
-        "makeswift-runtime-version": "0.28.7-canary.4",
+        "makeswift-runtime-version": "0.28.7-canary.5",
         "content-type": "application/json"
       },
       body: JSON.stringify({ token }),
@@ -957,7 +668,7 @@ Received "${apiKey}" instead.`
       return null;
     }
     const json = await response.json();
-    const parsed = previewTokenPayloadSchema.safeParse(json);
+    const parsed = Schema.previewTokenPayload.safeParse(json);
     if (!parsed.success) {
       throw new Error(
         `Failed to parse preview token payload: ${parsed.error.errors.map((e) => e.message).join("; ")}`
@@ -975,7 +686,7 @@ Received "${apiKey}" instead.`
       return null;
     }
     const json = await response.json();
-    const parsed = getFontsAPISchema.safeParse(json);
+    const parsed = Schema.fonts.safeParse(json);
     if (!parsed.success) {
       console.error("Failed to parse fonts API response", {
         response: json,
@@ -989,12 +700,39 @@ Received "${apiKey}" instead.`
     return getPropControllerDescriptors(this.runtime.protoStore.getState());
   }
 }
+function getPagesQueryParams({
+  limit = 100,
+  after,
+  sortBy,
+  sortDirection,
+  includeOffline,
+  pathPrefix,
+  locale
+}) {
+  const params = new URLSearchParams();
+  if (limit != null)
+    params.set("limit", limit.toString());
+  if (after != null)
+    params.set("after", after);
+  if (sortBy != null)
+    params.set("sortBy", sortBy);
+  if (sortDirection != null)
+    params.set("sortDirection", sortDirection);
+  if (includeOffline != null)
+    params.set("includeOffline", includeOffline.toString());
+  if (pathPrefix != null)
+    params.set("pathPrefix", pathPrefix);
+  if (locale != null)
+    params.set("locale", locale);
+  return params;
+}
+function responseError(response) {
+  return `${response.status} ${response.statusText}`;
+}
 export {
   MakeswiftClient,
-  SnippetLocation2 as SnippetLocation,
+  SnippetLocation,
   componentDocumentToRootEmbeddedDocument,
-  failedResponseBody,
-  pageToRootDocument,
-  previewTokenPayloadSchema
+  pageToRootDocument
 };
 //# sourceMappingURL=index.js.map