@dxos/plugin-youtube 0.8.3

package/src/translations.ts

@@ -0,0 +1,59 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type Resource } from '@dxos/react-ui';
+
+import { meta } from './meta';
+import { Channel, Video } from './types';
+
+export const translations = [
+  {
+    'en-US': {
+      [Channel.YouTubeChannel.typename]: {
+        'typename label': 'YouTube Channel',
+        'typename label_zero': 'YouTube Channels',
+        'typename label_one': 'YouTube Channel',
+        'typename label_other': 'YouTube Channels',
+        'object name placeholder': 'New YouTube channel',
+        'add object label': 'Add YouTube channel',
+        'rename object label': 'Rename YouTube channel',
+        'delete object label': 'Delete YouTube channel',
+        'object deleted label': 'YouTube channel deleted',
+      },
+      [Video.YouTubeVideo.typename]: {
+        'typename label': 'Video',
+        'typename label_zero': 'Videos',
+        'typename label_one': 'Video',
+        'typename label_other': 'Videos',
+        'object name placeholder': 'New video',
+        'add object label': 'Add video',
+        'rename object label': 'Rename video',
+        'delete object label': 'Delete video',
+        'object deleted label': 'Video deleted',
+      },
+      [meta.id]: {
+        'plugin name': 'YouTube',
+        'channel label': 'YouTube Channel',
+        'video label': 'Video',
+        'sync channel label': 'Sync channel',
+        'sync channel error title': 'Failed to sync channel',
+        'clear synced videos label': 'Clear synced videos',
+        'clear synced videos error title': 'Failed to clear synced videos',
+        'close label': 'Close',
+        'new channel label': 'New YouTube Channel',
+        'empty channel message': 'No videos synced yet',
+        'no video message': 'Select a video to view it',
+
+        'channel account label': 'Account',
+        'channel account placeholder': 'Select account...',
+        'channel sync label': 'Channel Sync',
+
+        'enable background sync label': 'Enable background sync',
+        'enabling background sync label': 'Enabling...',
+        'disable background sync label': 'Disable background sync',
+        'view trigger label': 'View trigger',
+      },
+    },
+  },
+] as const satisfies Resource[];

package/src/types/Channel.ts

@@ -0,0 +1,80 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Annotation, Feed, Obj, Ref, Type } from '@dxos/echo';
+import { FormInputAnnotation } from '@dxos/echo/internal';
+import { FeedAnnotation } from '@dxos/schema';
+import { AccessToken } from '@dxos/types';
+
+// @import-as-namespace
+
+/**
+ * YouTubeChannel schema representing a YouTube channel to sync videos from.
+ */
+export const YouTubeChannel = Schema.Struct({
+  /** Display name for the channel. */
+  name: Schema.String.pipe(Schema.optional),
+  /** YouTube channel ID (e.g., UC...). */
+  channelId: Schema.String.pipe(Schema.optional),
+  /** YouTube channel URL or handle. */
+  channelUrl: Schema.String.pipe(Schema.optional),
+  /** Feed containing YouTubeVideo objects. */
+  feed: Ref.Ref(Feed.Feed).pipe(FormInputAnnotation.set(false)),
+  /** Last sync timestamp. */
+  lastSyncedAt: Schema.String.pipe(FormInputAnnotation.set(false), Schema.optional),
+  /** Google API credentials for fetching channel data. */
+  accessToken: Schema.optional(
+    Ref.Ref(AccessToken.AccessToken).annotations({
+      title: 'Account',
+      description: 'Google account credentials for syncing this YouTube channel.',
+    }),
+  ),
+}).pipe(
+  Type.object({
+    typename: 'org.dxos.type.youtube-channel',
+    version: '0.1.0',
+  }),
+  Annotation.IconAnnotation.set({
+    icon: 'ph--youtube-logo--regular',
+    hue: 'red',
+  }),
+  FeedAnnotation.set(true),
+);
+
+export interface YouTubeChannel extends Schema.Schema.Type<typeof YouTubeChannel> {}
+
+/** Checks if a value is a YouTubeChannel object. */
+export const instanceOf = (value: unknown): value is YouTubeChannel => Obj.instanceOf(YouTubeChannel, value);
+
+export const CreateYouTubeChannelSchema = Schema.Struct({
+  name: Schema.optional(Schema.String.annotations({ title: 'Name' })),
+  channelUrl: Schema.optional(
+    Schema.String.annotations({
+      title: 'Channel URL',
+      description: 'YouTube channel URL, handle (e.g., @channelname), or channel ID.',
+    }),
+  ),
+  accessToken: Schema.optional(
+    Ref.Ref(AccessToken.AccessToken).annotations({
+      title: 'Account',
+      description: 'Google account credentials for syncing this YouTube channel.',
+    }),
+  ),
+});
+export interface CreateYouTubeChannelSchema extends Schema.Schema.Type<typeof CreateYouTubeChannelSchema> {}
+
+type YouTubeChannelProps = Omit<Obj.MakeProps<typeof YouTubeChannel>, 'feed' | 'lastSyncedAt'>;
+
+/** Creates a YouTubeChannel object with a backing feed. */
+export const make = (props: YouTubeChannelProps = {}) => {
+  const feed = Feed.make();
+  const channel = Obj.make(YouTubeChannel, {
+    feed: Ref.make(feed),
+    ...props,
+  });
+  Obj.setParent(feed, channel);
+  return channel;
+};

package/src/types/Video.ts

@@ -0,0 +1,67 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Annotation, Obj, Type } from '@dxos/echo';
+
+/**
+ * Transcript segment from a YouTube video.
+ */
+export const TranscriptSegment = Schema.Struct({
+  /** Transcript text. */
+  text: Schema.String,
+  /** Start time in seconds. */
+  offset: Schema.Number,
+  /** Duration in seconds. */
+  duration: Schema.Number,
+});
+
+export type TranscriptSegment = Schema.Schema.Type<typeof TranscriptSegment>;
+
+/**
+ * YouTubeVideo schema representing a video from a YouTube channel.
+ */
+export const YouTubeVideo = Schema.Struct({
+  /** Video title. */
+  title: Schema.String,
+  /** YouTube video ID. */
+  videoId: Schema.String,
+  /** Video description. */
+  description: Schema.String.pipe(Schema.optional),
+  /** Video URL. */
+  url: Schema.String,
+  /** Thumbnail URL. */
+  thumbnailUrl: Schema.String.pipe(Schema.optional),
+  /** Channel name. */
+  channelTitle: Schema.String.pipe(Schema.optional),
+  /** Published date as ISO string. */
+  publishedAt: Schema.String,
+  /** Video duration in ISO 8601 format (e.g., PT1H30M15S). */
+  duration: Schema.String.pipe(Schema.optional),
+  /** View count. */
+  viewCount: Schema.Number.pipe(Schema.optional),
+  /** Like count. */
+  likeCount: Schema.Number.pipe(Schema.optional),
+  /** Full transcript text. */
+  transcript: Schema.String.pipe(Schema.optional),
+  /** Transcript segments with timestamps. */
+  transcriptSegments: Schema.Array(TranscriptSegment).pipe(Schema.optional),
+  /** True when transcript text was successfully loaded; false when disabled or none available. */
+  transcriptFetched: Schema.Boolean.pipe(Schema.optional),
+}).pipe(
+  Type.object({
+    typename: 'org.dxos.type.youtube-video',
+    version: '0.1.0',
+  }),
+  Annotation.IconAnnotation.set({
+    icon: 'ph--play--regular',
+    hue: 'red',
+  }),
+);
+
+export interface YouTubeVideo extends Schema.Schema.Type<typeof YouTubeVideo> {}
+
+/** Checks if a value is a YouTubeVideo object. */
+export const instanceOf = (value: unknown): value is YouTubeVideo => Obj.instanceOf(YouTubeVideo, value);

package/src/types/index.ts

@@ -0,0 +1,8 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export * from './types';
+
+export * as Channel from './Channel';
+export * as Video from './Video';

package/src/types/types.ts

@@ -0,0 +1,10 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+/**
+ * YouTube plugin operations (placeholder for future expansion).
+ */
+export const YouTubeOperation = {
+  // Operations will be defined here when needed.
+} as const;