sanity-plugin-sgntech-interview 1.0.0

package/dist/_chunks-es/speakers.js

@@ -0,0 +1,36 @@
+function findSpeaker(speakers, id) {
+  if (Array.isArray(speakers) && id)
+    return speakers.find((speaker) => speaker.id === id);
+}
+function askingSpeaker(speakers, value) {
+  return findSpeaker(speakers, value?.askedBy) || (speakers ?? []).find((speaker) => speaker.interviewer);
+}
+function speakerLabel(speaker, fallback = "\u2014") {
+  return speaker?.name?.trim() || speaker?.id?.trim() || fallback;
+}
+function timestampSeconds(input) {
+  const raw = (input ?? "").trim();
+  if (!raw) return;
+  const parts = raw.split(":");
+  if (parts.length < 2 || parts.length > 3 || !parts.every((part) => /^\d{1,3}$/.test(part))) return;
+  const numbers = parts.map(Number), [hours, minutes, seconds] = numbers.length === 3 ? numbers : [0, numbers[0] ?? 0, numbers[1] ?? 0];
+  if (!(minutes > 59 || seconds > 59))
+    return hours * 3600 + minutes * 60 + seconds;
+}
+function timestampUrl(source, seconds) {
+  if (!source || seconds === void 0) return source;
+  const separator = source.includes("?") ? "&" : "?";
+  return /youtu\.?be/.test(source) ? `${source}${separator}t=${seconds}` : /vimeo\./.test(source) ? `${source}#t=${seconds}s` : `${source}${separator}t=${seconds}`;
+}
+function usableSpeakers(speakers) {
+  return Array.isArray(speakers) ? speakers.filter((speaker) => !!speaker?.id?.trim()) : [];
+}
+export {
+  askingSpeaker,
+  findSpeaker,
+  speakerLabel,
+  timestampSeconds,
+  timestampUrl,
+  usableSpeakers
+};
+//# sourceMappingURL=speakers.js.map

package/dist/_chunks-es/speakers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"speakers.js","sources":["../../src/lib/speakers.ts"],"sourcesContent":["import type {InterviewValue, Speaker} from './types'\n\n/**\n * The speaker a block refers to, or the first interviewer when it asks for one\n * without naming it.\n *\n * @public\n */\nexport function findSpeaker(\n  speakers: Speaker[] | undefined,\n  id: string | undefined,\n): Speaker | undefined {\n  if (!Array.isArray(speakers)) return undefined\n  if (id) return speakers.find((speaker) => speaker.id === id)\n  return undefined\n}\n\n/**\n * Who is asking: the block's own choice, otherwise the first speaker marked as\n * an interviewer.\n *\n * @public\n */\nexport function askingSpeaker(\n  speakers: Speaker[] | undefined,\n  value: InterviewValue | undefined,\n): Speaker | undefined {\n  const named = findSpeaker(speakers, value?.askedBy)\n  if (named) return named\n  return (speakers ?? []).find((speaker) => speaker.interviewer)\n}\n\n/**\n * What to print for a speaker, falling back through name, id and a dash so a\n * half-filled interview still renders.\n *\n * @public\n */\nexport function speakerLabel(speaker: Speaker | undefined, fallback = '—'): string {\n  return speaker?.name?.trim() || speaker?.id?.trim() || fallback\n}\n\n/**\n * Turns `12:34` or `1:02:33` into seconds, for links into a recording.\n *\n * Returns `undefined` for anything it cannot read, so a typo becomes a plain\n * label rather than a link to second zero.\n *\n * @public\n */\nexport function timestampSeconds(input: string | undefined): number | undefined {\n  const raw = (input ?? '').trim()\n  if (!raw) return undefined\n\n  const parts = raw.split(':')\n  if (parts.length < 2 || parts.length > 3) return undefined\n  if (!parts.every((part) => /^\\d{1,3}$/.test(part))) return undefined\n\n  const numbers = parts.map(Number)\n  const [hours, minutes, seconds] =\n    numbers.length === 3 ? numbers : [0, numbers[0] ?? 0, numbers[1] ?? 0]\n\n  if (minutes > 59 || seconds > 59) return undefined\n  return hours * 3600 + minutes * 60 + seconds\n}\n\n/**\n * Adds a start time to a media URL, in the form each service expects.\n *\n * @public\n */\nexport function timestampUrl(source: string | undefined, seconds: number | undefined): string | undefined {\n  if (!source || seconds === undefined) return source\n\n  const separator = source.includes('?') ? '&' : '?'\n  if (/youtu\\.?be/.test(source)) return `${source}${separator}t=${seconds}`\n  if (/vimeo\\./.test(source)) return `${source}#t=${seconds}s`\n  return `${source}${separator}t=${seconds}`\n}\n\n/**\n * Speakers that can actually be offered in a picker.\n *\n * @public\n */\nexport function usableSpeakers(speakers: Speaker[] | undefined): Speaker[] {\n  if (!Array.isArray(speakers)) return []\n  return speakers.filter((speaker) => Boolean(speaker?.id?.trim()))\n}\n"],"names":[],"mappings":"AAQO,SAAS,YACd,UACA,IACqB;AACrB,MAAK,MAAM,QAAQ,QAAQ,KACvB;AAAI,WAAO,SAAS,KAAK,CAAC,YAAY,QAAQ,OAAO,EAAE;AAE7D;AAQO,SAAS,cACd,UACA,OACqB;AAErB,SADc,YAAY,UAAU,OAAO,OAAO,MAE1C,YAAY,CAAA,GAAI,KAAK,CAAC,YAAY,QAAQ,WAAW;AAC/D;AAQO,SAAS,aAAa,SAA8B,WAAW,UAAa;AACjF,SAAO,SAAS,MAAM,KAAA,KAAU,SAAS,IAAI,UAAU;AACzD;AAUO,SAAS,iBAAiB,OAA+C;AAC9E,QAAM,OAAO,SAAS,IAAI,KAAA;AAC1B,MAAI,CAAC,IAAK;AAEV,QAAM,QAAQ,IAAI,MAAM,GAAG;AAE3B,MADI,MAAM,SAAS,KAAK,MAAM,SAAS,KACnC,CAAC,MAAM,MAAM,CAAC,SAAS,YAAY,KAAK,IAAI,CAAC,EAAG;AAEpD,QAAM,UAAU,MAAM,IAAI,MAAM,GAC1B,CAAC,OAAO,SAAS,OAAO,IAC5B,QAAQ,WAAW,IAAI,UAAU,CAAC,GAAG,QAAQ,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;AAEvE,MAAI,EAAA,UAAU,MAAM,UAAU;AAC9B,WAAO,QAAQ,OAAO,UAAU,KAAK;AACvC;AAOO,SAAS,aAAa,QAA4B,SAAiD;AACxG,MAAI,CAAC,UAAU,YAAY,OAAW,QAAO;AAE7C,QAAM,YAAY,OAAO,SAAS,GAAG,IAAI,MAAM;AAC/C,SAAI,aAAa,KAAK,MAAM,IAAU,GAAG,MAAM,GAAG,SAAS,KAAK,OAAO,KACnE,UAAU,KAAK,MAAM,IAAU,GAAG,MAAM,MAAM,OAAO,MAClD,GAAG,MAAM,GAAG,SAAS,KAAK,OAAO;AAC1C;AAOO,SAAS,eAAe,UAA4C;AACzE,SAAK,MAAM,QAAQ,QAAQ,IACpB,SAAS,OAAO,CAAC,YAAY,CAAA,CAAQ,SAAS,IAAI,KAAA,CAAO,IAD3B,CAAA;AAEvC;"}

package/dist/index.d.ts

@@ -0,0 +1,517 @@
+import { ArrayRule } from "sanity";
+import { ConditionalPropertyCallbackContext } from "sanity";
+import { Plugin as Plugin_2 } from "sanity";
+import { StringInputProps } from "sanity";
+import { StringRule } from "sanity";
+import { UrlRule } from "sanity";
+import { WidenInitialValue } from "sanity";
+import { WidenValidation } from "sanity";
+
+/**
+ * Any object with an `_type` that is a string. Can hold any other properties.
+ * @public
+ */
+declare type ArbitraryTypedObject = TypedObject & {
+  [key: string]: any;
+};
+
+/**
+ * Who is asking: the block's own choice, otherwise the first speaker marked as
+ * an interviewer.
+ *
+ * @public
+ */
+export declare function askingSpeaker(
+  speakers: Speaker[] | undefined,
+  value: InterviewValue | undefined,
+): Speaker | undefined;
+
+/**
+ * The question-and-answer block.
+ *
+ * @public
+ */
+export declare function createInterviewBlockType(config?: InterviewConfig): {
+  name: string;
+  title: string;
+  type: "object";
+  icon: typeof InterviewIcon;
+  fields: (
+    | ({
+        name: "speaker";
+        title: string;
+        type: "string";
+        components: {
+          input: typeof SpeakerInput;
+        };
+        validation: (rule: StringRule) => StringRule;
+      } & WidenValidation)
+    | ({
+        name: "question";
+        type: "string";
+        validation: (rule: StringRule) => StringRule;
+      } & WidenValidation)
+    | ({
+        name: "answer";
+        type: "array";
+        of: {
+          type: "block";
+          styles: {
+            title: string;
+            value: string;
+          }[];
+          lists: never[];
+          marks: {
+            decorators: {
+              title: string;
+              value: string;
+            }[];
+            annotations: {
+              type: "object";
+              name: "link";
+              title: string;
+              fields: ({
+                name: "href";
+                type: "url";
+                validation: (r: UrlRule) => UrlRule;
+              } & WidenValidation)[];
+            }[];
+          };
+        }[];
+        validation: (rule: ArrayRule<unknown[]>) => ArrayRule<unknown[]>;
+      } & WidenValidation)
+    | {
+        name: "askedBy";
+        title: string;
+        description: string;
+        type: "string";
+        components: {
+          input: typeof SpeakerInput;
+        };
+      }
+    | ({
+        name: "timestamp";
+        description: string;
+        type: "string";
+        validation: (rule: StringRule) => StringRule;
+      } & WidenValidation)
+    | ({
+        name: "translated";
+        title: string;
+        description: string;
+        type: "boolean";
+        initialValue: false;
+      } & WidenInitialValue)
+    | {
+        name: "originalAnswer";
+        title: string;
+        type: "text";
+        rows: number;
+        hidden: ({ parent }: ConditionalPropertyCallbackContext) => boolean;
+      }
+  )[];
+  preview: {
+    select: {
+      question: string;
+      speaker: string;
+      timestamp: string;
+    };
+    prepare: (select: Record<"speaker" | "question" | "timestamp", any>) => {
+      title: string;
+      subtitle: string;
+    };
+  };
+};
+
+/**
+ * The document field the blocks read their speakers from.
+ *
+ * Add it to any type that carries interviews:
+ *
+ * ```ts
+ * defineType({name: 'post', fields: [createSpeakersField(), /* … *\/]})
+ * ```
+ *
+ * @public
+ */
+export declare function createSpeakersField(config?: InterviewConfig): {
+  name: string;
+  title: string;
+  description: string;
+  type: "array";
+  of: {
+    type: "object";
+    name: "speaker";
+    fields: (
+      | ({
+          name: "id";
+          title: string;
+          description: string;
+          type: "string";
+          validation: (rule: StringRule) => StringRule;
+        } & WidenValidation)
+      | ({
+          name: "name";
+          type: "string";
+          validation: (rule: StringRule) => StringRule;
+        } & WidenValidation)
+      | {
+          name: "role";
+          description: string;
+          type: "string";
+        }
+      | ({
+          name: "interviewer";
+          title: string;
+          description: string;
+          type: "boolean";
+          initialValue: false;
+        } & WidenInitialValue)
+      | {
+          name: "person";
+          title: string;
+          description: string;
+          type: "reference";
+          to: {
+            type: string;
+          }[];
+        }
+    )[];
+    preview: {
+      select: {
+        title: string;
+        role: string;
+        id: string;
+        interviewer: string;
+      };
+      prepare: (
+        select: Record<"id" | "role" | "title" | "interviewer", any>,
+      ) => {
+        title: string;
+        subtitle: string;
+      };
+    };
+  }[];
+};
+
+/**
+ * The speaker a block refers to, or the first interviewer when it asks for one
+ * without naming it.
+ *
+ * @public
+ */
+export declare function findSpeaker(
+  speakers: Speaker[] | undefined,
+  id: string | undefined,
+): Speaker | undefined;
+
+/**
+ * Adds an `interviewBlock` to Sanity Studio: one question and its answer, as a
+ * block in the article body, so intros, photos and section headings can sit
+ * between the turns the way a printed interview does.
+ *
+ * Speakers are defined once on the document with `createSpeakersField`, and
+ * each block picks from that list — renaming somebody fixes every turn at once.
+ * An answer takes bold, italic and links, and can carry a timestamp into the
+ * recording plus a note when it was translated rather than quoted.
+ *
+ * ```ts
+ * import {defineArrayMember, defineConfig, defineField} from 'sanity'
+ * import {createSpeakersField, interview} from 'sanity-plugin-sgntech-interview'
+ *
+ * export default defineConfig({
+ *   plugins: [interview()],
+ *   schema: {
+ *     types: [
+ *       {
+ *         type: 'document',
+ *         name: 'post',
+ *         fields: [
+ *           createSpeakersField(),
+ *           defineField({
+ *             type: 'array',
+ *             name: 'body',
+ *             of: [defineArrayMember({type: 'block'}), defineArrayMember({type: 'interviewBlock'})],
+ *           }),
+ *         ],
+ *       },
+ *     ],
+ *   },
+ * })
+ * ```
+ *
+ * The React renderer lives under `sanity-plugin-sgntech-interview/render` and
+ * imports neither `sanity` nor `@sanity/ui`.
+ *
+ * @public
+ */
+export declare const interview: Plugin_2<void | InterviewConfig>;
+
+/**
+ * Configuration for the plugin.
+ *
+ * @public
+ */
+export declare interface InterviewConfig {
+  /** Block type name. Defaults to `interviewBlock`. */
+  name?: string;
+  /** Label in the editor. Defaults to `Interview`. */
+  title?: string;
+  /** Field name the speakers live in. Defaults to `interviewSpeakers`. */
+  speakersField?: string;
+  /** Document types a speaker may point at, e.g. `['author', 'bandMember']`. */
+  speakerTypes?: string[];
+  /** Marks allowed in an answer. Defaults to bold, italic and link. */
+  answerMarks?: {
+    decorators?: string[];
+    link?: boolean;
+  };
+  /** Adds the timestamp field. Defaults to `true`. */
+  timestamps?: boolean;
+  /** Adds the translation fields. Defaults to `true`. */
+  translation?: boolean;
+}
+
+/**
+ * Two speech turns, drawn to match the stroke weight of `@sanity/icons`.
+ */
+export declare function InterviewIcon(): React.JSX.Element;
+
+/**
+ * One question and its answer.
+ *
+ * @public
+ */
+export declare interface InterviewValue {
+  _key?: string;
+  _type?: string;
+  question?: string;
+  answer?: PortableTextBlock[];
+  /** Who is answering; matches {@link Speaker.id}. */
+  speaker?: string;
+  /** Who is asking, when it is not the document's default interviewer. */
+  askedBy?: string;
+  /** `12:34` or `1:02:33`, pointing into the recording. */
+  timestamp?: string;
+  /** Set when the answer was translated rather than quoted verbatim. */
+  translated?: boolean;
+  /** The answer as it was actually said. */
+  originalAnswer?: string;
+}
+
+/**
+ * A Portable Text Block can be thought of as one paragraph, quote or list item.
+ * In other words, it is a container for text, that can have a visual style associated with it.
+ * The actual text value is stored in portable text spans inside of the `childen` array.
+ *
+ * @typeParam M - Mark types that be used for text spans
+ * @typeParam C - Types allowed as children of this block
+ * @typeParam S - Allowed block styles (eg `normal`, `blockquote`, `h3` etc)
+ * @typeParam L - Allowed list item types (eg `number`, `bullet` etc)
+ * @public
+ */
+declare interface PortableTextBlock<
+  M extends PortableTextMarkDefinition = PortableTextMarkDefinition,
+  C extends TypedObject = ArbitraryTypedObject | PortableTextSpan,
+  S extends string = PortableTextBlockStyle,
+  L extends string = PortableTextListItemType,
+> extends TypedObject {
+  /**
+   * Type name identifying this as a portable text block.
+   * All items within a portable text array should have a `_type` property.
+   *
+   * Usually 'block', but can be customized to other values
+   */
+  _type: "block" | (string & {});
+  /**
+   * A key that identifies this block uniquely within the parent array. Used to more easily address
+   * the block when editing collaboratively, but is also very useful for keys inside of React and
+   * other rendering frameworks that can use keys to optimize operations.
+   */
+  _key?: string;
+  /**
+   * Array of inline items for this block. Usually contain text spans, but can be
+   * configured to include inline objects of other types as well.
+   */
+  children: C[];
+  /**
+   * Array of mark definitions used in child text spans. By having them be on the block level,
+   * the same mark definition can be reused for multiple text spans, which is often the case
+   * with nested marks.
+   */
+  markDefs?: M[];
+  /**
+   * Visual style of the block
+   * Common values: 'normal', 'blockquote', 'h1'...'h6'
+   */
+  style?: S;
+  /**
+   * If this block is a list item, identifies which style of list item this is
+   * Common values: 'bullet', 'number', but can be configured
+   */
+  listItem?: L;
+  /**
+   * If this block is a list item, identifies which level of nesting it belongs within
+   */
+  level?: number;
+}
+
+/**
+ * A set of _common_ (but not required/standarized) block styles
+ * @public
+ */
+declare type PortableTextBlockStyle =
+  | "normal"
+  | "blockquote"
+  | "h1"
+  | "h2"
+  | "h3"
+  | "h4"
+  | "h5"
+  | "h6"
+  | (string & {});
+
+/**
+ * A set of _common_ (but not required/standardized) list item types
+ * @public
+ */
+declare type PortableTextListItemType = "bullet" | "number" | (string & {});
+
+/**
+ * A mark definition holds information for marked text. For instance, a text span could reference
+ * a mark definition for a hyperlink, a geoposition, a reference to a document or anything that is
+ * representable as a JSON object.
+ * @public
+ */
+declare interface PortableTextMarkDefinition {
+  /**
+   * Unknown properties
+   */
+  [key: string]: unknown;
+  /**
+   * Identifies the type of mark this is, and is used to pick the correct React components to use
+   * when rendering a text span marked with this mark type.
+   */
+  _type: string;
+  /**
+   * Uniquely identifies this mark definition within the block
+   */
+  _key: string;
+}
+
+/**
+ * A Portable Text Span holds a chunk of the actual text value of a Portable Text Block
+ * @public
+ */
+declare interface PortableTextSpan {
+  /**
+   * Type is always `span` for portable text spans, as these don't vary in shape
+   */
+  _type: "span";
+  /**
+   * Unique (within parent block) key for this portable text span
+   */
+  _key?: string;
+  /**
+   * The actual text value of this text span
+   */
+  text: string;
+  /**
+   * An array of marks this text span is annotated with, identified by its `_key`.
+   * If the key cannot be found in the parent blocks mark definition, the mark is assumed to be a
+   * decorator (a simpler mark without any properties - for instance `strong` or `em`)
+   */
+  marks?: string[];
+}
+
+/**
+ * Someone taking part in the interview, defined once on the document.
+ *
+ * @public
+ */
+export declare interface Speaker {
+  _key?: string;
+  /** Short id the blocks refer to, e.g. `till`. */
+  id?: string;
+  name?: string;
+  /** Shown under the name, e.g. `Guitarist` or `Editor`. */
+  role?: string;
+  /** Marks who is asking, so a renderer can style questions differently. */
+  interviewer?: boolean;
+  /** Set when the speaker is a reference to a person document. */
+  person?: {
+    _ref?: string;
+    _type?: string;
+  };
+}
+
+/**
+ * Picks one of the speakers defined on the document.
+ *
+ * @public
+ */
+export declare function SpeakerInput(
+  props: StringInputProps,
+): React.JSX.Element;
+
+/**
+ * What to print for a speaker, falling back through name, id and a dash so a
+ * half-filled interview still renders.
+ *
+ * @public
+ */
+export declare function speakerLabel(
+  speaker: Speaker | undefined,
+  fallback?: string,
+): string;
+
+/**
+ * Turns `12:34` or `1:02:33` into seconds, for links into a recording.
+ *
+ * Returns `undefined` for anything it cannot read, so a typo becomes a plain
+ * label rather than a link to second zero.
+ *
+ * @public
+ */
+export declare function timestampSeconds(
+  input: string | undefined,
+): number | undefined;
+
+/**
+ * Adds a start time to a media URL, in the form each service expects.
+ *
+ * @public
+ */
+export declare function timestampUrl(
+  source: string | undefined,
+  seconds: number | undefined,
+): string | undefined;
+
+/**
+ * Any object with an `_type` property (which is required in portable text arrays),
+ * as well as a _potential_ `_key` (highly encouraged)
+ * @public
+ */
+declare interface TypedObject {
+  /**
+   * Identifies the type of object/span this is, and is used to pick the correct React components
+   * to use when rendering a span or inline object with this type.
+   */
+  _type: string;
+  /**
+   * Uniquely identifies this object within its parent block.
+   * Not _required_, but highly encouraged.
+   */
+  _key?: string;
+}
+
+/**
+ * Speakers that can actually be offered in a picker.
+ *
+ * @public
+ */
+export declare function usableSpeakers(
+  speakers: Speaker[] | undefined,
+): Speaker[];
+
+export {};

package/dist/index.js

@@ -0,0 +1,17 @@
+import "sanity";
+import { InterviewIcon, SpeakerInput, createInterviewBlockType, createSpeakersField, interview } from "./_chunks-es/index.js";
+import { askingSpeaker, findSpeaker, speakerLabel, timestampSeconds, timestampUrl, usableSpeakers } from "./_chunks-es/speakers.js";
+export {
+  InterviewIcon,
+  SpeakerInput,
+  askingSpeaker,
+  createInterviewBlockType,
+  createSpeakersField,
+  findSpeaker,
+  interview,
+  speakerLabel,
+  timestampSeconds,
+  timestampUrl,
+  usableSpeakers
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}