@luckystack/devkit 0.6.7 → 0.7.1

package/dist/templates/sync_client_paired.template.ts

@@ -1,38 +1,38 @@
-/* eslint-disable unicorn/no-abusive-eslint-disable */
-/* eslint-disable */
-
-//@ts-ignore We replace {{REL_PATH}} with the relative path to the project root at scaffold time.
-import { Functions, SyncClientResponse, SyncClientInput, SyncServerOutput, MaybePromise, SyncClientStreamEmitter } from '{{REL_PATH}}src/_sockets/apiTypes.generated';
-
-// Types are imported from the generated file based on the _server_v{number}.ts definition
-type PagePath = '{{PAGE_PATH}}';
-type SyncName = '{{SYNC_NAME}}';
-
-export interface SyncParams {
-  clientInput: SyncClientInput<PagePath, SyncName>;
-  serverOutput: SyncServerOutput<PagePath, SyncName>;
-  token: string | null; // target client's session token (fetch session only when needed)
-  functions: Functions; // contains all functions that are available on the server in the functions folder
-  roomCode: string; // room code
-  stream: SyncClientStreamEmitter;
-}
-
-export const main = ({  }: SyncParams): MaybePromise<SyncClientResponse> => {
-  // PAIRED SYNC: Types are shared with the _server_v{number}.ts file
-  // clientInput type comes from _server_v{number}.ts SyncParams
-  // serverOutput type is inferred from _server_v{number}.ts return value
-  // stream payload types are generated from your stream(...) calls in this file
-  // Use functions.session.getSession(token) when you need session data for this target client.
-  // Returning error here only affects the current target client and does not stop other clients.
-
-  // Example: Only allow users on set page to receive the event
-  // const targetUser = token ? await functions.session.getSession(token) : null;
-  // if (targetUser?.location?.pathName === '/your-page') {
-  //   return { status: 'success' };
-  // }
-
-  return {
-    status: 'success',
-    // Add any additional data to pass to the client
-  };
-};
+/* eslint-disable unicorn/no-abusive-eslint-disable */
+/* eslint-disable */
+
+//@ts-ignore We replace {{REL_PATH}} with the relative path to the project root at scaffold time.
+import { Functions, SyncClientResponse, SyncClientInput, SyncServerOutput, MaybePromise, SyncClientStreamEmitter } from '{{REL_PATH}}src/_sockets/apiTypes.generated';
+
+// Types are imported from the generated file based on the _server_v{number}.ts definition
+type PagePath = '{{PAGE_PATH}}';
+type SyncName = '{{SYNC_NAME}}';
+
+export interface SyncParams {
+  clientInput: SyncClientInput<PagePath, SyncName>;
+  serverOutput: SyncServerOutput<PagePath, SyncName>;
+  token: string | null; // target client's session token (fetch session only when needed)
+  functions: Functions; // contains all functions that are available on the server in the functions folder
+  roomCode: string; // room code
+  stream: SyncClientStreamEmitter;
+}
+
+export const main = ({  }: SyncParams): MaybePromise<SyncClientResponse> => {
+  // PAIRED SYNC: Types are shared with the _server_v{number}.ts file
+  // clientInput type comes from _server_v{number}.ts SyncParams
+  // serverOutput type is inferred from _server_v{number}.ts return value
+  // stream payload types are generated from your stream(...) calls in this file
+  // Use functions.session.getSession(token) when you need session data for this target client.
+  // Returning error here only affects the current target client and does not stop other clients.
+
+  // Example: Only allow users on set page to receive the event
+  // const targetUser = token ? await functions.session.getSession(token) : null;
+  // if (targetUser?.location?.pathName === '/your-page') {
+  //   return { status: 'success' };
+  // }
+
+  return {
+    status: 'success',
+    // Add any additional data to pass to the client
+  };
+};

package/dist/templates/sync_client_standalone.template.ts

@@ -1,36 +1,36 @@
-/* eslint-disable unicorn/no-abusive-eslint-disable */
-/* eslint-disable */
-
-//@ts-ignore We replace {{REL_PATH}} with the relative path to the project root at scaffold time.
-import { Functions, SyncClientResponse, MaybePromise, SyncClientStreamEmitter } from '{{REL_PATH}}src/_sockets/apiTypes.generated';
-
-
-export interface SyncParams {
-  clientInput: {
-    // Define the data shape sent from the client e.g.
-    // message: string;
-  };
-  // Note: No serverOutput in client-only syncs (no _server_v{number}.ts file)
-  token: string | null; // target client's session token (fetch session only when needed)
-  functions: Functions; // contains all functions that are available on the server in the functions folder
-  roomCode: string; // room code
-  stream: SyncClientStreamEmitter;
-}
-
-export const main = ({  }: SyncParams): MaybePromise<SyncClientResponse> => {
-  // CLIENT-ONLY SYNC: No server processing, runs for each client in the room
-  // stream payload types are generated from your stream(...) calls in this file
-  // Use functions.session.getSession(token) when you need session data for this target client.
-  // Returning error here only affects the current target client and does not stop other clients.
-
-  // Example: Only allow users on set page to receive the event
-  // const targetUser = token ? await functions.session.getSession(token) : null;
-  // if (targetUser?.location?.pathName === '/your-page') {
-  //   return { status: 'success' };
-  // }
-
-  return {
-    status: 'success',
-    // Add any additional data to pass to the client
-  };
-};
+/* eslint-disable unicorn/no-abusive-eslint-disable */
+/* eslint-disable */
+
+//@ts-ignore We replace {{REL_PATH}} with the relative path to the project root at scaffold time.
+import { Functions, SyncClientResponse, MaybePromise, SyncClientStreamEmitter } from '{{REL_PATH}}src/_sockets/apiTypes.generated';
+
+
+export interface SyncParams {
+  clientInput: {
+    // Define the data shape sent from the client e.g.
+    // message: string;
+  };
+  // Note: No serverOutput in client-only syncs (no _server_v{number}.ts file)
+  token: string | null; // target client's session token (fetch session only when needed)
+  functions: Functions; // contains all functions that are available on the server in the functions folder
+  roomCode: string; // room code
+  stream: SyncClientStreamEmitter;
+}
+
+export const main = ({  }: SyncParams): MaybePromise<SyncClientResponse> => {
+  // CLIENT-ONLY SYNC: No server processing, runs for each client in the room
+  // stream payload types are generated from your stream(...) calls in this file
+  // Use functions.session.getSession(token) when you need session data for this target client.
+  // Returning error here only affects the current target client and does not stop other clients.
+
+  // Example: Only allow users on set page to receive the event
+  // const targetUser = token ? await functions.session.getSession(token) : null;
+  // if (targetUser?.location?.pathName === '/your-page') {
+  //   return { status: 'success' };
+  // }
+
+  return {
+    status: 'success',
+    // Add any additional data to pass to the client
+  };
+};

package/dist/templates/sync_server.template.ts

@@ -1,65 +1,65 @@
-/* eslint-disable unicorn/no-abusive-eslint-disable */
-/* eslint-disable */
-
-//@ts-ignore We replace {{REL_PATH}} with the relative path to the project root at scaffold time.
-import { AuthProps, SessionLayout } from '{{REL_PATH}}config';
-//@ts-ignore We replace {{REL_PATH}} with the relative path to the project root at scaffold time.
-import { Functions, SyncServerResponse, MaybePromise, SyncServerStreamEmitter, SyncBroadcastStreamEmitter, SyncStreamToEmitter } from '{{REL_PATH}}src/_sockets/apiTypes.generated';
-
-export const auth: AuthProps = {
-  login: true,
-  additional: []
-};
-
-export interface SyncParams {
-  clientInput: {
-    // Define the data shape sent from the client e.g.
-    // message: string;
-    // targetUserId: string;
-  };
-  user: SessionLayout; // session data of the user who called the sync event
-  functions: Functions; // functions object
-  roomCode: string; // room code
-  //? Stream primitives — pick whichever audience matches your use case:
-  //?   stream            → originator only (cheapest)
-  //?   broadcastStream   → every socket in the receiver room (live AI chat, collab)
-  //?   streamTo          → specific session tokens only (selective subscribers)
-  stream: SyncServerStreamEmitter;
-  broadcastStream: SyncBroadcastStreamEmitter;
-  streamTo: SyncStreamToEmitter;
-  //? Aborts on client-side cancel (`syncRequest({ signal })`) or socket
-  //? disconnect. Check `abortSignal.aborted` in long-running loops and bail
-  //? out — already-emitted chunks are not unsent, but new ones are
-  //? short-circuited automatically by the stream emitters.
-  abortSignal: AbortSignal;
-  //? Awaitable backpressure helper. Resolves once the worst-case write
-  //? buffer across affected sockets drops below the threshold (default 1 MB).
-  //? Use opt-in between batches of stream chunks to keep memory bounded.
-  flushPressure: (options?: { thresholdBytes?: number }) => Promise<void>;
-}
-
-export const main = ({  }: SyncParams): MaybePromise<SyncServerResponse> => {
-  // THIS FILE RUNS JUST ONCE ON THE SERVER
-
-  // Stream payload types are generated from your stream(...) calls.
-  // stream({ phase: 'validate', progress: 10 });           // → originator only
-  // broadcastStream({ chunk: 'hello' });                   // → everyone in the room
-  // streamTo([adminToken], { audit: 'event' });            // → specific tokens
-
-  // For LLM token streams, coalesce small pieces with createStreamThrottle:
-  //   import { createStreamThrottle } from '@luckystack/sync';
-  //   const throttle = createStreamThrottle({ flushEveryMs: 50, flushAtChars: 32 });
-  //   for await (const piece of aiStream) throttle.push(piece.text, broadcastStream);
-  //   throttle.flush(broadcastStream);
-
-  // Return { status: 'error', message: '...' } OR { status: 'error', errorCode: '...' }
-  // Returning error here aborts the full sync flow.
-
-  // Please validate clientInput here and dont just send the data back to the other clients
-  // optional: database action or something else
-
-  return {
-    status: 'success',
-    // Add any data you want to broadcast to clients
-  };
+/* eslint-disable unicorn/no-abusive-eslint-disable */
+/* eslint-disable */
+
+//@ts-ignore We replace {{REL_PATH}} with the relative path to the project root at scaffold time.
+import { AuthProps, SessionLayout } from '{{REL_PATH}}config';
+//@ts-ignore We replace {{REL_PATH}} with the relative path to the project root at scaffold time.
+import { Functions, SyncServerResponse, MaybePromise, SyncServerStreamEmitter, SyncBroadcastStreamEmitter, SyncStreamToEmitter } from '{{REL_PATH}}src/_sockets/apiTypes.generated';
+
+export const auth: AuthProps = {
+  login: true,
+  additional: []
+};
+
+export interface SyncParams {
+  clientInput: {
+    // Define the data shape sent from the client e.g.
+    // message: string;
+    // targetUserId: string;
+  };
+  user: SessionLayout; // session data of the user who called the sync event
+  functions: Functions; // functions object
+  roomCode: string; // room code
+  //? Stream primitives — pick whichever audience matches your use case:
+  //?   stream            → originator only (cheapest)
+  //?   broadcastStream   → every socket in the receiver room (live AI chat, collab)
+  //?   streamTo          → specific session tokens only (selective subscribers)
+  stream: SyncServerStreamEmitter;
+  broadcastStream: SyncBroadcastStreamEmitter;
+  streamTo: SyncStreamToEmitter;
+  //? Aborts on client-side cancel (`syncRequest({ signal })`) or socket
+  //? disconnect. Check `abortSignal.aborted` in long-running loops and bail
+  //? out — already-emitted chunks are not unsent, but new ones are
+  //? short-circuited automatically by the stream emitters.
+  abortSignal: AbortSignal;
+  //? Awaitable backpressure helper. Resolves once the worst-case write
+  //? buffer across affected sockets drops below the threshold (default 1 MB).
+  //? Use opt-in between batches of stream chunks to keep memory bounded.
+  flushPressure: (options?: { thresholdBytes?: number }) => Promise<void>;
+}
+
+export const main = ({  }: SyncParams): MaybePromise<SyncServerResponse> => {
+  // THIS FILE RUNS JUST ONCE ON THE SERVER
+
+  // Stream payload types are generated from your stream(...) calls.
+  // stream({ phase: 'validate', progress: 10 });           // → originator only
+  // broadcastStream({ chunk: 'hello' });                   // → everyone in the room
+  // streamTo([adminToken], { audit: 'event' });            // → specific tokens
+
+  // For LLM token streams, coalesce small pieces with createStreamThrottle:
+  //   import { createStreamThrottle } from '@luckystack/sync';
+  //   const throttle = createStreamThrottle({ flushEveryMs: 50, flushAtChars: 32 });
+  //   for await (const piece of aiStream) throttle.push(piece.text, broadcastStream);
+  //   throttle.flush(broadcastStream);
+
+  // Return { status: 'error', message: '...' } OR { status: 'error', errorCode: '...' }
+  // Returning error here aborts the full sync flow.
+
+  // Please validate clientInput here and dont just send the data back to the other clients
+  // optional: database action or something else
+
+  return {
+    status: 'success',
+    // Add any data you want to broadcast to clients
+  };
 };