@cmssy/core 11.9.0 → 12.1.0

package/dist/index.cjs

@@ -499,6 +499,19 @@ var fields = {
   }
 };
 
+// src/media.ts
+function mediaUrl(value) {
+  if (typeof value === "string") return value || null;
+  return value?.url ?? null;
+}
+function mediaUrls(value) {
+  if (!Array.isArray(value)) return [];
+  return value.map((item) => mediaUrl(item)).filter((url) => url !== null);
+}
+function mediaAlt(value) {
+  return typeof value === "string" ? void 0 : value?.alt;
+}
+
 // src/data/localize-href.ts
 var PROTOCOL_OR_RELATIVE = /^([a-z][a-z0-9+.-]*:|\/\/)/i;
 function isExternalHref(href) {
@@ -879,6 +892,9 @@ exports.graphqlRequest = graphqlRequest;
 exports.isProtocolCompatible = isProtocolCompatible;
 exports.isVerifiedEditUrl = isVerifiedEditUrl;
 exports.localizeHref = localizeHref;
+exports.mediaAlt = mediaAlt;
+exports.mediaUrl = mediaUrl;
+exports.mediaUrls = mediaUrls;
 exports.normalizeOrigin = normalizeOrigin;
 exports.parseEditorMessage = parseEditorMessage;
 exports.postToEditor = postToEditor;

package/dist/index.d.cts

@@ -2,7 +2,7 @@ export { A as AppToEditorMessage, B as BoundsMessage, C as ClickMessage, a as Cm
 export { C as CMSSY_LOCALE_HEADER, G as GraphqlRequestOptions, g as graphqlRequest, l as localizeHref, r as resolveCmssyLocale } from './locale-BS61R-fF.cjs';
 export { C as CmssyRequestError, D as DEFAULT_CMSSY_API_URL, F as FetchLike, a as FetchLikeResponse, b as FetchPageOptions, R as RetryPolicy } from './content-client-BPpRfq0h.cjs';
 import * as _cmssy_types from '@cmssy/types';
-import { FieldOptions, TypedField, MediaFieldValue, BlockPropsSchema, InferBlockContent, RelationMode, CmssyModelRecord, VerifyCmssyWebhookOptions, CmssyWebhookEvent } from '@cmssy/types';
+import { FieldOptions, TypedField, ResolvedMediaValue, BlockPropsSchema, InferBlockContent, RelationMode, CmssyModelRecord, ResolvedMedia, VerifyCmssyWebhookOptions, CmssyWebhookEvent } from '@cmssy/types';
 export { BlockMeta, BlockPropsSchema, BlockRect, BlockSchema, BuildBlockContextExtra, CmssyBlockAuthContext, CmssyBlockContext, CmssyBlockMember, CmssyBlockPage, CmssyBlockWorkspace, CmssyBranding, CmssyClientConfig, CmssyFormDefinition, CmssyFormField, CmssyFormSettings, CmssyFormSubmitResponse, CmssyLayoutGroup, CmssyLayoutSettings, CmssyLocaleContext, CmssyLocalizedValue, CmssyModelDefinition, CmssyModelRecord, CmssyPageData, CmssyPageMeta, CmssyPageSummary, CmssyRecordList, CmssySiteConfig, CmssyWebhookEvent, CmssyWebhookOrder, FieldCondition, FieldConditionGroup, FieldConditionLogic, FieldControl, FieldDefinition, FieldOptions, FieldType, InferBlockContent, LayoutPosition, RawBlock, RawLayoutBlock, SubmitFormInput, TypedField, VerifyCmssyWebhookOptions, evaluateFieldConditionGroup, layoutPositionValues } from '@cmssy/types';
 
 type Declared<O> = O extends {
@@ -11,7 +11,7 @@ type Declared<O> = O extends {
 type OptionValue<O> = O extends {
     options: readonly (infer Option extends string)[];
 } ? Option : string;
-type MediaValue<O> = MediaFieldValue<O extends {
+type MediaValue<O> = ResolvedMediaValue<O extends {
     multiple: true;
 } ? true : false>;
 type RepeaterValue<O> = O extends {
@@ -54,6 +54,18 @@ declare const fields: {
     relation: <const O extends RelationFieldOptions>(opts: O) => TypedField<RelationValue<O>, Declared<O>>;
 };
 
+/**
+ * A media value as it can reach a block during the CMS-1149 transition: the
+ * resolved object a current API returns, or the bare URL string an API that
+ * has not been upgraded yet still returns. The string arm exists so a site can
+ * upgrade its SDK and its cmssy independently; it goes away once no supported
+ * cmssy serves strings.
+ */
+type MediaLike = ResolvedMedia | string | null | undefined;
+declare function mediaUrl(value: MediaLike): string | null;
+declare function mediaUrls(value: readonly MediaLike[] | null | undefined): string[];
+declare function mediaAlt(value: MediaLike): string | undefined;
+
 declare const CMSSY_EDIT_HEADER = "x-cmssy-edit";
 declare const CMSSY_EDIT_QUERY_PARAM = "cmssyEdit";
 declare const CMSSY_SECRET_QUERY_PARAM = "cmssySecret";
@@ -72,4 +84,4 @@ declare class CmssyWebhookError extends Error {
 }
 declare function verifyCmssyWebhook(options: VerifyCmssyWebhookOptions): Promise<CmssyWebhookEvent>;
 
-export { CMSSY_EDIT_HEADER, CMSSY_EDIT_QUERY_PARAM, CMSSY_SECRET_QUERY_PARAM, CmssyWebhookError, fields, isVerifiedEditUrl, verifyCmssyWebhook };
+export { CMSSY_EDIT_HEADER, CMSSY_EDIT_QUERY_PARAM, CMSSY_SECRET_QUERY_PARAM, CmssyWebhookError, type MediaLike, fields, isVerifiedEditUrl, mediaAlt, mediaUrl, mediaUrls, verifyCmssyWebhook };

package/dist/index.d.ts

@@ -2,7 +2,7 @@ export { A as AppToEditorMessage, B as BoundsMessage, C as ClickMessage, a as Cm
 export { C as CMSSY_LOCALE_HEADER, G as GraphqlRequestOptions, g as graphqlRequest, l as localizeHref, r as resolveCmssyLocale } from './locale-DQZ80cew.js';
 export { C as CmssyRequestError, D as DEFAULT_CMSSY_API_URL, F as FetchLike, a as FetchLikeResponse, b as FetchPageOptions, R as RetryPolicy } from './content-client-BPpRfq0h.js';
 import * as _cmssy_types from '@cmssy/types';
-import { FieldOptions, TypedField, MediaFieldValue, BlockPropsSchema, InferBlockContent, RelationMode, CmssyModelRecord, VerifyCmssyWebhookOptions, CmssyWebhookEvent } from '@cmssy/types';
+import { FieldOptions, TypedField, ResolvedMediaValue, BlockPropsSchema, InferBlockContent, RelationMode, CmssyModelRecord, ResolvedMedia, VerifyCmssyWebhookOptions, CmssyWebhookEvent } from '@cmssy/types';
 export { BlockMeta, BlockPropsSchema, BlockRect, BlockSchema, BuildBlockContextExtra, CmssyBlockAuthContext, CmssyBlockContext, CmssyBlockMember, CmssyBlockPage, CmssyBlockWorkspace, CmssyBranding, CmssyClientConfig, CmssyFormDefinition, CmssyFormField, CmssyFormSettings, CmssyFormSubmitResponse, CmssyLayoutGroup, CmssyLayoutSettings, CmssyLocaleContext, CmssyLocalizedValue, CmssyModelDefinition, CmssyModelRecord, CmssyPageData, CmssyPageMeta, CmssyPageSummary, CmssyRecordList, CmssySiteConfig, CmssyWebhookEvent, CmssyWebhookOrder, FieldCondition, FieldConditionGroup, FieldConditionLogic, FieldControl, FieldDefinition, FieldOptions, FieldType, InferBlockContent, LayoutPosition, RawBlock, RawLayoutBlock, SubmitFormInput, TypedField, VerifyCmssyWebhookOptions, evaluateFieldConditionGroup, layoutPositionValues } from '@cmssy/types';
 
 type Declared<O> = O extends {
@@ -11,7 +11,7 @@ type Declared<O> = O extends {
 type OptionValue<O> = O extends {
     options: readonly (infer Option extends string)[];
 } ? Option : string;
-type MediaValue<O> = MediaFieldValue<O extends {
+type MediaValue<O> = ResolvedMediaValue<O extends {
     multiple: true;
 } ? true : false>;
 type RepeaterValue<O> = O extends {
@@ -54,6 +54,18 @@ declare const fields: {
     relation: <const O extends RelationFieldOptions>(opts: O) => TypedField<RelationValue<O>, Declared<O>>;
 };
 
+/**
+ * A media value as it can reach a block during the CMS-1149 transition: the
+ * resolved object a current API returns, or the bare URL string an API that
+ * has not been upgraded yet still returns. The string arm exists so a site can
+ * upgrade its SDK and its cmssy independently; it goes away once no supported
+ * cmssy serves strings.
+ */
+type MediaLike = ResolvedMedia | string | null | undefined;
+declare function mediaUrl(value: MediaLike): string | null;
+declare function mediaUrls(value: readonly MediaLike[] | null | undefined): string[];
+declare function mediaAlt(value: MediaLike): string | undefined;
+
 declare const CMSSY_EDIT_HEADER = "x-cmssy-edit";
 declare const CMSSY_EDIT_QUERY_PARAM = "cmssyEdit";
 declare const CMSSY_SECRET_QUERY_PARAM = "cmssySecret";
@@ -72,4 +84,4 @@ declare class CmssyWebhookError extends Error {
 }
 declare function verifyCmssyWebhook(options: VerifyCmssyWebhookOptions): Promise<CmssyWebhookEvent>;
 
-export { CMSSY_EDIT_HEADER, CMSSY_EDIT_QUERY_PARAM, CMSSY_SECRET_QUERY_PARAM, CmssyWebhookError, fields, isVerifiedEditUrl, verifyCmssyWebhook };
+export { CMSSY_EDIT_HEADER, CMSSY_EDIT_QUERY_PARAM, CMSSY_SECRET_QUERY_PARAM, CmssyWebhookError, type MediaLike, fields, isVerifiedEditUrl, mediaAlt, mediaUrl, mediaUrls, verifyCmssyWebhook };

package/dist/index.js

@@ -497,6 +497,19 @@ var fields = {
   }
 };
 
+// src/media.ts
+function mediaUrl(value) {
+  if (typeof value === "string") return value || null;
+  return value?.url ?? null;
+}
+function mediaUrls(value) {
+  if (!Array.isArray(value)) return [];
+  return value.map((item) => mediaUrl(item)).filter((url) => url !== null);
+}
+function mediaAlt(value) {
+  return typeof value === "string" ? void 0 : value?.alt;
+}
+
 // src/data/localize-href.ts
 var PROTOCOL_OR_RELATIVE = /^([a-z][a-z0-9+.-]*:|\/\/)/i;
 function isExternalHref(href) {
@@ -852,4 +865,4 @@ async function verifyCmssyWebhook(options) {
   return parsed;
 }
 
-export { CMSSY_EDIT_HEADER, CMSSY_EDIT_QUERY_PARAM, CMSSY_LOCALE_HEADER, CMSSY_SECRET_QUERY_PARAM, CmssyRequestError, CmssyWebhookError, DEFAULT_CMSSY_API_URL, DEFAULT_CMSSY_EDITOR_ORIGINS, PROTOCOL_VERSION, applyCmssyCsp, createCmssyClient, defineCmssyConfig, fields, graphqlRequest, isProtocolCompatible, isVerifiedEditUrl, localizeHref, normalizeOrigin, parseEditorMessage, postToEditor, resolveCmssyLocale, resolveEditorOrigin, verifyCmssyWebhook };
+export { CMSSY_EDIT_HEADER, CMSSY_EDIT_QUERY_PARAM, CMSSY_LOCALE_HEADER, CMSSY_SECRET_QUERY_PARAM, CmssyRequestError, CmssyWebhookError, DEFAULT_CMSSY_API_URL, DEFAULT_CMSSY_EDITOR_ORIGINS, PROTOCOL_VERSION, applyCmssyCsp, createCmssyClient, defineCmssyConfig, fields, graphqlRequest, isProtocolCompatible, isVerifiedEditUrl, localizeHref, mediaAlt, mediaUrl, mediaUrls, normalizeOrigin, parseEditorMessage, postToEditor, resolveCmssyLocale, resolveEditorOrigin, verifyCmssyWebhook };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cmssy/core",
-  "version": "11.9.0",
+  "version": "12.1.0",
   "description": "Framework-agnostic cmssy gateway: GraphQL client, block/field system, editor protocol. No React, no Next.",
   "keywords": [
     "cmssy",
@@ -87,7 +87,7 @@
     "vitest": "^2.1.0"
   },
   "dependencies": {
-    "@cmssy/types": "0.34.0",
+    "@cmssy/types": "0.35.0",
     "jose": "^6.2.3"
   },
   "scripts": {