@antiphony/shared 0.5.1 → 0.6.0

package/README.md

@@ -34,7 +34,7 @@ The root re-exports the most-used pieces (audio records + views, codecs, NSIDs,
 | `@antiphony/shared/errors` | Shared error types and helpers. |
 | `@antiphony/shared/utils` | Pure shared utilities (projection/date/sanitization helpers). |
 | `@antiphony/shared/observability` | Logging/error-reporting helpers (`./observability/report-error` for just the reporter). |
-| `@antiphony/shared/types/*` | Individual type modules: `audio`, `blob`, `processing`, `records`. |
+| `@antiphony/shared/types/*` | Individual type modules: `audio`, `blob`, `processing`, `records`, `url`. |
 
 ## The records this models
 

package/dist/cjs/api-codecs.cjs

@@ -149,11 +149,14 @@ var ProcessingStateSchema = ResolvedProcessingSchema.extend({
   updatedAt: FirestoreTimestampSchema
 });
 var ProcessingViewSchema = ProcessingStageMapSchema;
+function httpsUrl() {
+  return zod.z.string().trim().url().regex(/^https?:\/\//i, { message: "URL must use the http or https scheme" });
+}
 
 // types/audio.ts
 var StrongRefSchema = zod.z.object({
-  uri: zod.z.string().regex(/^at:\/\/.+/, "Must be an at:// URI"),
-  cid: zod.z.string()
+  uri: zod.z.string().regex(/^at:\/\/.+/, "Must be an at:// URI").max(512),
+  cid: zod.z.string().max(128)
 });
 var ReplyRefSchema = zod.z.object({
   root: StrongRefSchema,
@@ -195,8 +198,13 @@ var AudioEmbedViewSchema = zod.z.object({
    * it to change (trim removes leading/trailing silence), and should render
    * these three as a set rather than caching them independently. The record's
    * originals are immutable and unaffected; this is a read-time resolution.
+   *
+   * Restricted to `http:`/`https:` (`httpsUrl()`), not any URL `new URL()`
+   * will parse. This is the value clients hand to `<audio src>`, so a
+   * `javascript:` or `data:` URL reaching one is stored XSS — and a bare
+   * `.url()` accepts both. See `types/url.ts`.
    */
-  url: zod.z.string().url(),
+  url: httpsUrl(),
   durationMs: zod.z.number().int().min(0).optional(),
   // `alt` is copied from the stored embed; keep the same bounds so a view can
   // never carry a larger payload than the record allows.
@@ -300,7 +308,13 @@ zod.z.object({
 zod.z.object({
   handle: zod.z.string().min(3).max(20).optional(),
   usageIntent: zod.z.string().max(100).optional(),
-  rssFeed: zod.z.string().url().optional()
+  /**
+   * Feed URL, restricted to `http:`/`https:` for the same reason
+   * `AudioEmbedView.url` is: an app renders this as an `<a href>`, and a bare
+   * `.url()` would let a `javascript:` URL through. A feed is a fetchable web
+   * document, so no legitimate value loses anything to the restriction.
+   */
+  rssFeed: httpsUrl().optional()
 });
 var ViewerStateSchema = zod.z.object({
   /** True when the authenticated caller authored this post. */
@@ -354,9 +368,9 @@ var CreateAudioPostRequestSchema = zod.z.object({
   /** Present ⇒ this is a reply (StrongRef root + parent). */
   reply: ReplyRefSchema.optional(),
   /** BCP-47 language tags. */
-  langs: zod.z.array(zod.z.string()).max(3).optional(),
+  langs: zod.z.array(zod.z.string().max(35)).max(3).optional(),
   /** Author self-label values (content warnings). */
-  selfLabels: zod.z.array(zod.z.string()).optional(),
+  selfLabels: zod.z.array(zod.z.string().max(128)).max(10).optional(),
   /**
    * Opt-in audio processing for this post's audio (denoise / trim /
    * transcribe / waveform). All default off. Stages the deployment can't

package/dist/cjs/api-codecs.d.cts

@@ -53,9 +53,9 @@ declare const CreateAudioPostRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObjec
             mimeType: string;
             size: number;
         };
-        waveform?: number[] | undefined;
         durationMs?: number | undefined;
         alt?: string | undefined;
+        waveform?: number[] | undefined;
     }, {
         $type: "dev.antiphony.embed.audio";
         audio: {
@@ -66,9 +66,9 @@ declare const CreateAudioPostRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObjec
             mimeType: string;
             size: number;
         };
-        waveform?: number[] | undefined;
         durationMs?: number | undefined;
         alt?: string | undefined;
+        waveform?: number[] | undefined;
     }>>;
     /** Present ⇒ this is a reply (StrongRef root + parent). */
     reply: z.ZodOptional<z.ZodObject<{
@@ -130,37 +130,20 @@ declare const CreateAudioPostRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObjec
         waveform: z.ZodOptional<z.ZodBoolean>;
         reprocess: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
+        waveform?: boolean | undefined;
+        transcribe?: boolean | undefined;
         denoise?: boolean | undefined;
         trim?: boolean | undefined;
-        transcribe?: boolean | undefined;
-        waveform?: boolean | undefined;
         reprocess?: boolean | undefined;
     }, {
+        waveform?: boolean | undefined;
+        transcribe?: boolean | undefined;
         denoise?: boolean | undefined;
         trim?: boolean | undefined;
-        transcribe?: boolean | undefined;
-        waveform?: boolean | undefined;
         reprocess?: boolean | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     text: string;
-    processing?: {
-        denoise?: boolean | undefined;
-        trim?: boolean | undefined;
-        transcribe?: boolean | undefined;
-        waveform?: boolean | undefined;
-        reprocess?: boolean | undefined;
-    } | undefined;
-    reply?: {
-        root: {
-            uri: string;
-            cid: string;
-        };
-        parent: {
-            uri: string;
-            cid: string;
-        };
-    } | undefined;
     title?: string | undefined;
     embed?: {
         $type: "dev.antiphony.embed.audio";
@@ -172,20 +155,9 @@ declare const CreateAudioPostRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObjec
             mimeType: string;
             size: number;
         };
-        waveform?: number[] | undefined;
         durationMs?: number | undefined;
         alt?: string | undefined;
-    } | undefined;
-    langs?: string[] | undefined;
-    selfLabels?: string[] | undefined;
-}, {
-    text?: string | undefined;
-    processing?: {
-        denoise?: boolean | undefined;
-        trim?: boolean | undefined;
-        transcribe?: boolean | undefined;
-        waveform?: boolean | undefined;
-        reprocess?: boolean | undefined;
+        waveform?: number[] | undefined;
     } | undefined;
     reply?: {
         root: {
@@ -197,6 +169,17 @@ declare const CreateAudioPostRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObjec
             cid: string;
         };
     } | undefined;
+    langs?: string[] | undefined;
+    selfLabels?: string[] | undefined;
+    processing?: {
+        waveform?: boolean | undefined;
+        transcribe?: boolean | undefined;
+        denoise?: boolean | undefined;
+        trim?: boolean | undefined;
+        reprocess?: boolean | undefined;
+    } | undefined;
+}, {
+    text?: string | undefined;
     title?: string | undefined;
     embed?: {
         $type: "dev.antiphony.embed.audio";
@@ -208,20 +191,9 @@ declare const CreateAudioPostRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObjec
             mimeType: string;
             size: number;
         };
-        waveform?: number[] | undefined;
         durationMs?: number | undefined;
         alt?: string | undefined;
-    } | undefined;
-    langs?: string[] | undefined;
-    selfLabels?: string[] | undefined;
-}>, {
-    text: string;
-    processing?: {
-        denoise?: boolean | undefined;
-        trim?: boolean | undefined;
-        transcribe?: boolean | undefined;
-        waveform?: boolean | undefined;
-        reprocess?: boolean | undefined;
+        waveform?: number[] | undefined;
     } | undefined;
     reply?: {
         root: {
@@ -233,6 +205,17 @@ declare const CreateAudioPostRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObjec
             cid: string;
         };
     } | undefined;
+    langs?: string[] | undefined;
+    selfLabels?: string[] | undefined;
+    processing?: {
+        waveform?: boolean | undefined;
+        transcribe?: boolean | undefined;
+        denoise?: boolean | undefined;
+        trim?: boolean | undefined;
+        reprocess?: boolean | undefined;
+    } | undefined;
+}>, {
+    text: string;
     title?: string | undefined;
     embed?: {
         $type: "dev.antiphony.embed.audio";
@@ -244,20 +227,9 @@ declare const CreateAudioPostRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObjec
             mimeType: string;
             size: number;
         };
-        waveform?: number[] | undefined;
         durationMs?: number | undefined;
         alt?: string | undefined;
-    } | undefined;
-    langs?: string[] | undefined;
-    selfLabels?: string[] | undefined;
-}, {
-    text?: string | undefined;
-    processing?: {
-        denoise?: boolean | undefined;
-        trim?: boolean | undefined;
-        transcribe?: boolean | undefined;
-        waveform?: boolean | undefined;
-        reprocess?: boolean | undefined;
+        waveform?: number[] | undefined;
     } | undefined;
     reply?: {
         root: {
@@ -269,6 +241,17 @@ declare const CreateAudioPostRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObjec
             cid: string;
         };
     } | undefined;
+    langs?: string[] | undefined;
+    selfLabels?: string[] | undefined;
+    processing?: {
+        waveform?: boolean | undefined;
+        transcribe?: boolean | undefined;
+        denoise?: boolean | undefined;
+        trim?: boolean | undefined;
+        reprocess?: boolean | undefined;
+    } | undefined;
+}, {
+    text?: string | undefined;
     title?: string | undefined;
     embed?: {
         $type: "dev.antiphony.embed.audio";
@@ -280,20 +263,9 @@ declare const CreateAudioPostRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObjec
             mimeType: string;
             size: number;
         };
-        waveform?: number[] | undefined;
         durationMs?: number | undefined;
         alt?: string | undefined;
-    } | undefined;
-    langs?: string[] | undefined;
-    selfLabels?: string[] | undefined;
-}>, {
-    text: string;
-    processing?: {
-        denoise?: boolean | undefined;
-        trim?: boolean | undefined;
-        transcribe?: boolean | undefined;
-        waveform?: boolean | undefined;
-        reprocess?: boolean | undefined;
+        waveform?: number[] | undefined;
     } | undefined;
     reply?: {
         root: {
@@ -305,6 +277,17 @@ declare const CreateAudioPostRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObjec
             cid: string;
         };
     } | undefined;
+    langs?: string[] | undefined;
+    selfLabels?: string[] | undefined;
+    processing?: {
+        waveform?: boolean | undefined;
+        transcribe?: boolean | undefined;
+        denoise?: boolean | undefined;
+        trim?: boolean | undefined;
+        reprocess?: boolean | undefined;
+    } | undefined;
+}>, {
+    text: string;
     title?: string | undefined;
     embed?: {
         $type: "dev.antiphony.embed.audio";
@@ -316,20 +299,9 @@ declare const CreateAudioPostRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObjec
             mimeType: string;
             size: number;
         };
-        waveform?: number[] | undefined;
         durationMs?: number | undefined;
         alt?: string | undefined;
-    } | undefined;
-    langs?: string[] | undefined;
-    selfLabels?: string[] | undefined;
-}, {
-    text?: string | undefined;
-    processing?: {
-        denoise?: boolean | undefined;
-        trim?: boolean | undefined;
-        transcribe?: boolean | undefined;
-        waveform?: boolean | undefined;
-        reprocess?: boolean | undefined;
+        waveform?: number[] | undefined;
     } | undefined;
     reply?: {
         root: {
@@ -341,6 +313,17 @@ declare const CreateAudioPostRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObjec
             cid: string;
         };
     } | undefined;
+    langs?: string[] | undefined;
+    selfLabels?: string[] | undefined;
+    processing?: {
+        waveform?: boolean | undefined;
+        transcribe?: boolean | undefined;
+        denoise?: boolean | undefined;
+        trim?: boolean | undefined;
+        reprocess?: boolean | undefined;
+    } | undefined;
+}, {
+    text?: string | undefined;
     title?: string | undefined;
     embed?: {
         $type: "dev.antiphony.embed.audio";
@@ -352,12 +335,29 @@ declare const CreateAudioPostRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObjec
             mimeType: string;
             size: number;
         };
-        waveform?: number[] | undefined;
         durationMs?: number | undefined;
         alt?: string | undefined;
+        waveform?: number[] | undefined;
+    } | undefined;
+    reply?: {
+        root: {
+            uri: string;
+            cid: string;
+        };
+        parent: {
+            uri: string;
+            cid: string;
+        };
     } | undefined;
     langs?: string[] | undefined;
     selfLabels?: string[] | undefined;
+    processing?: {
+        waveform?: boolean | undefined;
+        transcribe?: boolean | undefined;
+        denoise?: boolean | undefined;
+        trim?: boolean | undefined;
+        reprocess?: boolean | undefined;
+    } | undefined;
 }>;
 type CreateAudioPostRequest = z.infer<typeof CreateAudioPostRequestSchema>;
 /**
@@ -379,32 +379,32 @@ declare const PatchAudioPostRequestSchema: z.ZodObject<{
         waveform: z.ZodOptional<z.ZodBoolean>;
         reprocess: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
+        waveform?: boolean | undefined;
+        transcribe?: boolean | undefined;
         denoise?: boolean | undefined;
         trim?: boolean | undefined;
-        transcribe?: boolean | undefined;
-        waveform?: boolean | undefined;
         reprocess?: boolean | undefined;
     }, {
+        waveform?: boolean | undefined;
+        transcribe?: boolean | undefined;
         denoise?: boolean | undefined;
         trim?: boolean | undefined;
-        transcribe?: boolean | undefined;
-        waveform?: boolean | undefined;
         reprocess?: boolean | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
     processing: {
+        waveform?: boolean | undefined;
+        transcribe?: boolean | undefined;
         denoise?: boolean | undefined;
         trim?: boolean | undefined;
-        transcribe?: boolean | undefined;
-        waveform?: boolean | undefined;
         reprocess?: boolean | undefined;
     };
 }, {
     processing: {
+        waveform?: boolean | undefined;
+        transcribe?: boolean | undefined;
         denoise?: boolean | undefined;
         trim?: boolean | undefined;
-        transcribe?: boolean | undefined;
-        waveform?: boolean | undefined;
         reprocess?: boolean | undefined;
     };
 }>;

package/dist/cjs/index.cjs

@@ -184,11 +184,14 @@ function resolveAudioVariant(canonical, state) {
     waveform: peaksAreCurrent ? state.waveformPeaks : canonical.waveform
   };
 }
+function httpsUrl() {
+  return zod.z.string().trim().url().regex(/^https?:\/\//i, { message: "URL must use the http or https scheme" });
+}
 
 // types/audio.ts
 var StrongRefSchema = zod.z.object({
-  uri: zod.z.string().regex(/^at:\/\/.+/, "Must be an at:// URI"),
-  cid: zod.z.string()
+  uri: zod.z.string().regex(/^at:\/\/.+/, "Must be an at:// URI").max(512),
+  cid: zod.z.string().max(128)
 });
 var ReplyRefSchema = zod.z.object({
   root: StrongRefSchema,
@@ -230,8 +233,13 @@ var AudioEmbedViewSchema = zod.z.object({
    * it to change (trim removes leading/trailing silence), and should render
    * these three as a set rather than caching them independently. The record's
    * originals are immutable and unaffected; this is a read-time resolution.
+   *
+   * Restricted to `http:`/`https:` (`httpsUrl()`), not any URL `new URL()`
+   * will parse. This is the value clients hand to `<audio src>`, so a
+   * `javascript:` or `data:` URL reaching one is stored XSS — and a bare
+   * `.url()` accepts both. See `types/url.ts`.
    */
-  url: zod.z.string().url(),
+  url: httpsUrl(),
   durationMs: zod.z.number().int().min(0).optional(),
   // `alt` is copied from the stored embed; keep the same bounds so a view can
   // never carry a larger payload than the record allows.
@@ -335,7 +343,13 @@ var TranscriptEnrichmentRecordSchema = zod.z.object({
 var ActorProfileRecordSchema = zod.z.object({
   handle: zod.z.string().min(3).max(20).optional(),
   usageIntent: zod.z.string().max(100).optional(),
-  rssFeed: zod.z.string().url().optional()
+  /**
+   * Feed URL, restricted to `http:`/`https:` for the same reason
+   * `AudioEmbedView.url` is: an app renders this as an `<a href>`, and a bare
+   * `.url()` would let a `javascript:` URL through. A feed is a fetchable web
+   * document, so no legitimate value loses anything to the restriction.
+   */
+  rssFeed: httpsUrl().optional()
 });
 var ViewerStateSchema = zod.z.object({
   /** True when the authenticated caller authored this post. */
@@ -389,9 +403,9 @@ var CreateAudioPostRequestSchema = zod.z.object({
   /** Present ⇒ this is a reply (StrongRef root + parent). */
   reply: ReplyRefSchema.optional(),
   /** BCP-47 language tags. */
-  langs: zod.z.array(zod.z.string()).max(3).optional(),
+  langs: zod.z.array(zod.z.string().max(35)).max(3).optional(),
   /** Author self-label values (content warnings). */
-  selfLabels: zod.z.array(zod.z.string()).optional(),
+  selfLabels: zod.z.array(zod.z.string().max(128)).max(10).optional(),
   /**
    * Opt-in audio processing for this post's audio (denoise / trim /
    * transcribe / waveform). All default off. Stages the deployment can't
@@ -572,6 +586,7 @@ exports.ValidationError = ValidationError;
 exports.ViewerStateSchema = ViewerStateSchema;
 exports.XRPC_NSID = XRPC_NSID;
 exports.buildReportedErrorEvent = buildReportedErrorEvent;
+exports.httpsUrl = httpsUrl;
 exports.isFirestoreTimestamp = isFirestoreTimestamp;
 exports.reportError = reportError;
 exports.resolveAudioVariant = resolveAudioVariant;

package/dist/cjs/index.d.cts

@@ -3,6 +3,7 @@ export { FirestoreTimestamp, FirestoreTimestampSchema } from './types/records.cj
 export { ActorProfileRecord, ActorProfileRecordSchema, AudioEmbed, AudioEmbedSchema, AudioEmbedView, AudioEmbedViewSchema, AudioPostRecord, AudioPostRecordSchema, AudioPostView, AudioPostViewSchema, PostRecordPublic, PostRecordPublicSchema, ReplyRef, ReplyRefSchema, StrongRef, StrongRefSchema, TimedTranscript, TimedTranscriptSchema, TranscriptEnrichmentRecord, TranscriptEnrichmentRecordSchema, TranscriptSegment, TranscriptSegmentSchema, ViewerState, ViewerStateSchema } from './types/audio.cjs';
 export { BYTE_MUTATING_STAGES, CanonicalAudioFields, DERIVED_STAGES, PROCESSING_STAGES, ProcessingRequest, ProcessingRequestSchema, ProcessingStage, ProcessingStageMap, ProcessingStageMapSchema, ProcessingStageSchema, ProcessingStageStatus, ProcessingStageStatusSchema, ProcessingState, ProcessingStateSchema, ProcessingView, ProcessingViewSchema, ResolvedProcessing, ResolvedProcessingSchema, resolveAudioVariant, toProcessingView } from './types/processing.cjs';
 export { BlobRef, BlobRefSchema } from './types/blob.cjs';
+export { httpsUrl } from './types/url.cjs';
 export { COLLECTIONS, EMBED_NSID, NSID, NsidValue, StoredNsidValue, XRPC_NSID, XrpcNsidValue } from './nsid.cjs';
 export { ConflictError, ForbiddenError, NotFoundError, RateLimitError, ServiceError, UnauthorizedError, ValidationError } from './errors/index.cjs';
 export { isFirestoreTimestamp } from './utils/index.cjs';

package/dist/cjs/types/audio.cjs

@@ -149,11 +149,14 @@ var ProcessingStateSchema = ResolvedProcessingSchema.extend({
   updatedAt: FirestoreTimestampSchema
 });
 var ProcessingViewSchema = ProcessingStageMapSchema;
+function httpsUrl() {
+  return zod.z.string().trim().url().regex(/^https?:\/\//i, { message: "URL must use the http or https scheme" });
+}
 
 // types/audio.ts
 var StrongRefSchema = zod.z.object({
-  uri: zod.z.string().regex(/^at:\/\/.+/, "Must be an at:// URI"),
-  cid: zod.z.string()
+  uri: zod.z.string().regex(/^at:\/\/.+/, "Must be an at:// URI").max(512),
+  cid: zod.z.string().max(128)
 });
 var ReplyRefSchema = zod.z.object({
   root: StrongRefSchema,
@@ -195,8 +198,13 @@ var AudioEmbedViewSchema = zod.z.object({
    * it to change (trim removes leading/trailing silence), and should render
    * these three as a set rather than caching them independently. The record's
    * originals are immutable and unaffected; this is a read-time resolution.
+   *
+   * Restricted to `http:`/`https:` (`httpsUrl()`), not any URL `new URL()`
+   * will parse. This is the value clients hand to `<audio src>`, so a
+   * `javascript:` or `data:` URL reaching one is stored XSS — and a bare
+   * `.url()` accepts both. See `types/url.ts`.
    */
-  url: zod.z.string().url(),
+  url: httpsUrl(),
   durationMs: zod.z.number().int().min(0).optional(),
   // `alt` is copied from the stored embed; keep the same bounds so a view can
   // never carry a larger payload than the record allows.
@@ -300,7 +308,13 @@ var TranscriptEnrichmentRecordSchema = zod.z.object({
 var ActorProfileRecordSchema = zod.z.object({
   handle: zod.z.string().min(3).max(20).optional(),
   usageIntent: zod.z.string().max(100).optional(),
-  rssFeed: zod.z.string().url().optional()
+  /**
+   * Feed URL, restricted to `http:`/`https:` for the same reason
+   * `AudioEmbedView.url` is: an app renders this as an `<a href>`, and a bare
+   * `.url()` would let a `javascript:` URL through. A feed is a fetchable web
+   * document, so no legitimate value loses anything to the restriction.
+   */
+  rssFeed: httpsUrl().optional()
 });
 var ViewerStateSchema = zod.z.object({
   /** True when the authenticated caller authored this post. */