@pagepocket/contracts 0.8.0

package/dist/elements.d.ts

@@ -0,0 +1,49 @@
+export type MatchQuery = string | {
+    selector?: string;
+    tagName?: string;
+    id?: string;
+    attrs?: Record<string, string | RegExp | true>;
+};
+export type ReplaceAction = {
+    type: "replaceWithHtml";
+    html: string;
+} | {
+    type: "replaceWithElement";
+    tagName: string;
+    textContent?: string;
+    html?: string;
+    attrs?: Record<string, string | null>;
+} | {
+    type: "renameTag";
+    to: string;
+    keepAttributes?: boolean;
+    keepChildren?: boolean;
+} | {
+    type: "remove";
+};
+export type ApplyOptions = {
+    scope?: "document" | "allFrames";
+    limit?: number | "all";
+    onReplaced?: "stop" | "continue";
+};
+export type ReplaceElementRule = {
+    name?: string;
+    match: MatchQuery;
+    replace: ReplaceAction;
+    apply?: ApplyOptions;
+};
+export type ReplaceElementContext = {
+    $: unknown;
+    $el: unknown;
+    url: string;
+    entryUrl: string;
+    ruleIndex: number;
+    matchIndex: number;
+};
+export type ReplaceElementFn = (ctx: ReplaceElementContext) => void | ReplaceAction | ReplaceAction[] | Promise<void | ReplaceAction | ReplaceAction[]>;
+export type ReplaceElementFnWithQuery = {
+    query: string;
+    apply?: ApplyOptions;
+    run: ReplaceElementFn;
+};
+export type ReplaceElementsConfig = Array<ReplaceElementRule | ReplaceElementFn | ReplaceElementFnWithQuery>;

package/dist/elements.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export type { ChannelToken } from "./tokens.js";
+export { createChannelToken } from "./tokens.js";
+export type { MatchQuery, ReplaceAction, ApplyOptions, ReplaceElementRule, ReplaceElementContext, ReplaceElementFn, ReplaceElementFnWithQuery, ReplaceElementsConfig } from "./elements.js";
+export type { DebugEvent } from "./well-known.js";
+export { NETWORK, DEBUG } from "./well-known.js";

package/dist/index.js

@@ -0,0 +1,2 @@
+export { createChannelToken } from "./tokens.js";
+export { NETWORK, DEBUG } from "./well-known.js";

package/dist/tokens.d.ts

@@ -0,0 +1,7 @@
+export type ChannelToken<T> = {
+    readonly kind: "channel";
+    readonly id: `pagepocket:${string}`;
+    readonly name: string;
+    readonly __type?: (value: T) => T;
+};
+export declare const createChannelToken: <T>(name: string) => ChannelToken<T>;

package/dist/tokens.js

@@ -0,0 +1,7 @@
+export const createChannelToken = (name) => {
+    return {
+        kind: "channel",
+        id: `pagepocket:${name}`,
+        name
+    };
+};

package/dist/well-known.d.ts

@@ -0,0 +1,38 @@
+export type NetworkEvent = {
+    type: "request";
+    requestId: string;
+    url: string;
+    method: string;
+    headers: Record<string, string>;
+    frameId?: string;
+    resourceType?: string;
+    initiator?: {
+        type?: string;
+        url?: string;
+    };
+    timestamp: number;
+} | {
+    type: "response";
+    requestId: string;
+    url: string;
+    status: number;
+    statusText?: string;
+    headers: Record<string, string>;
+    mimeType?: string;
+    fromDiskCache?: boolean;
+    fromServiceWorker?: boolean;
+    timestamp: number;
+    body?: unknown;
+} | {
+    type: "failed";
+    requestId: string;
+    url: string;
+    errorText: string;
+    timestamp: number;
+};
+export type DebugEvent = {
+    msg: string;
+    meta?: unknown;
+};
+export declare const NETWORK: import("./tokens.js").ChannelToken<NetworkEvent>;
+export declare const DEBUG: import("./tokens.js").ChannelToken<DebugEvent>;

package/dist/well-known.js

@@ -0,0 +1,3 @@
+import { createChannelToken } from "./tokens.js";
+export const NETWORK = createChannelToken("network@1");
+export const DEBUG = createChannelToken("debug@1");

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@pagepocket/contracts",
+  "version": "0.8.0",
+  "description": "PagePocket v3 shared contracts: tokens and element patch types.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "license": "ISC",
+  "dependencies": {},
+  "devDependencies": {
+    "typescript": "^5.4.5"
+  },
+  "scripts": {
+    "build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.json",
+    "test": "node -e \"process.exit(0)\""
+  }
+}