@sanity/client 4.0.1 → 5.0.0-esm.0

package/src/validators.ts

@@ -0,0 +1,76 @@
+const VALID_ASSET_TYPES = ['image', 'file']
+const VALID_INSERT_LOCATIONS = ['before', 'after', 'replace']
+
+export const dataset = (name: string) => {
+  if (!/^(~[a-z0-9]{1}[-\w]{0,63}|[a-z0-9]{1}[-\w]{0,63})$/.test(name)) {
+    throw new Error(
+      'Datasets can only contain lowercase characters, numbers, underscores and dashes, and start with tilde, and be maximum 64 characters'
+    )
+  }
+}
+
+export const projectId = (id: any) => {
+  if (!/^[-a-z0-9]+$/i.test(id)) {
+    throw new Error('`projectId` can only contain only a-z, 0-9 and dashes')
+  }
+}
+
+export const validateAssetType = (type: string) => {
+  if (VALID_ASSET_TYPES.indexOf(type) === -1) {
+    throw new Error(`Invalid asset type: ${type}. Must be one of ${VALID_ASSET_TYPES.join(', ')}`)
+  }
+}
+
+export const validateObject = (op: string, val: any) => {
+  if (val === null || typeof val !== 'object' || Array.isArray(val)) {
+    throw new Error(`${op}() takes an object of properties`)
+  }
+}
+
+export const validateDocumentId = (op: string, id: string) => {
+  if (typeof id !== 'string' || !/^[a-z0-9_.-]+$/i.test(id)) {
+    throw new Error(`${op}(): "${id}" is not a valid document ID`)
+  }
+}
+
+export const requireDocumentId = (op: string, doc: Record<string, any>) => {
+  if (!doc._id) {
+    throw new Error(`${op}() requires that the document contains an ID ("_id" property)`)
+  }
+
+  validateDocumentId(op, doc._id)
+}
+
+export const validateInsert = (at: string, selector: string, items: any[]) => {
+  const signature = 'insert(at, selector, items)'
+  if (VALID_INSERT_LOCATIONS.indexOf(at) === -1) {
+    const valid = VALID_INSERT_LOCATIONS.map((loc) => `"${loc}"`).join(', ')
+    throw new Error(`${signature} takes an "at"-argument which is one of: ${valid}`)
+  }
+
+  if (typeof selector !== 'string') {
+    throw new Error(`${signature} takes a "selector"-argument which must be a string`)
+  }
+
+  if (!Array.isArray(items)) {
+    throw new Error(`${signature} takes an "items"-argument which must be an array`)
+  }
+}
+
+export const hasDataset = (config: any): string => {
+  if (!config.dataset) {
+    throw new Error('`dataset` must be provided to perform queries')
+  }
+
+  return config.dataset || ''
+}
+
+export const requestTag = (tag: string) => {
+  if (typeof tag !== 'string' || !/^[a-z0-9._-]{1,75}$/i.test(tag)) {
+    throw new Error(
+      `Tag can only contain alphanumeric characters, underscores, dashes and dots, and be between one and 75 characters long.`
+    )
+  }
+
+  return tag
+}

package/src/warnings.ts

@@ -0,0 +1,25 @@
+import generateHelpUrl from './generateHelpUrl'
+import once from './util/once'
+
+const createWarningPrinter = (message: string[]) =>
+  // eslint-disable-next-line no-console
+  once((...args: any[]) => console.warn(message.join(' '), ...args))
+
+export const printCdnWarning = createWarningPrinter([
+  'You are not using the Sanity CDN. That means your data is always fresh, but the CDN is faster and',
+  `cheaper. Think about it! For more info, see ${generateHelpUrl('js-client-cdn-configuration')}.`,
+  'To hide this warning, please set the `useCdn` option to either `true` or `false` when creating',
+  'the client.',
+])
+
+export const printBrowserTokenWarning = createWarningPrinter([
+  'You have configured Sanity client to use a token in the browser. This may cause unintentional security issues.',
+  `See ${generateHelpUrl(
+    'js-client-browser-token'
+  )} for more information and how to hide this warning.`,
+])
+
+export const printNoApiVersionSpecifiedWarning = createWarningPrinter([
+  'Using the Sanity client without specifying an API version is deprecated.',
+  `See ${generateHelpUrl('js-client-api-version')}`,
+])