@doubling/types 0.1.0

package/README.md

@@ -0,0 +1,34 @@
+# @doubling/types
+
+Shared TypeScript interfaces and pure helpers consumed by `web/` and `sync/`. Single source of truth for Firestore document shapes (file/folder entities, org membership, teams, user profiles), file-extension to MIME mappings, and storage-path helpers.
+
+Lives at the repo root as an npm workspace (`@doubling/types`). The compiled output is shipped at `dist/`, regenerated on `npm install` via the `prepare` script and rebuilt explicitly via `npm run build`.
+
+## Why this exists
+
+Before this package, `web/` and `sync/` each kept their own copy of:
+
+- File / folder document shapes (web as a TS interface, sync via JSDoc).
+- The `EXT_TO_MIME` table mapping extensions to MIME types.
+- `mimeTypeFromExt`, `isTextMimeType`, `extFromPath`, `storagePathFor`.
+
+The duplication was load-bearing for shipping (web and sync run in different environments and the bytes / hash helpers are necessarily environment-specific), but the static parts drifted. New text extensions that landed on one side and not the other caused the daemon to upload with `application/octet-stream` while the web's eager-load path skipped the file because the mime didn't match. Adding `@doubling/types` collapses both copies for the static parts and leaves the env-specific bytes / hash helpers in each consumer.
+
+## Layout
+
+- `src/firestore.ts`: `FileEntity`, `FolderEntity`, `Entity`, `OrgMembership`, `OrgMember`, `Team`, `TeamMember`, `UserProfile`, `Scope`.
+- `src/mime.ts`: `EXT_TO_MIME`, `mimeTypeFromExt`, `isTextMimeType`.
+- `src/paths.ts`: `extFromPath`, `storagePathFor`.
+- `src/index.ts`: barrel export.
+
+## Adding a new extension
+
+Edit `EXT_TO_MIME` in `src/mime.ts`. That's it. Both `web/` and `sync/` pick up the new entry on the next `tsc` build. No need to touch any other file.
+
+## Build
+
+```
+npm run -w types build
+```
+
+Emits `dist/index.js` plus `dist/*.d.ts`. The `dist/` directory is gitignored; CI runs the build automatically via the `prepare` script on `npm install`.

package/dist/firestore.d.ts

@@ -0,0 +1,59 @@
+export type Scope = 'team' | 'private';
+interface EntityBase {
+    id: string;
+    path?: string;
+    name?: string;
+    parentId?: string | null;
+    scope?: Scope | string;
+    teamId?: string | null;
+    ownerId?: string | null;
+    sharedWith?: string[];
+    createdAt?: number | string;
+    updatedAt?: number | string;
+}
+export interface FileEntity extends EntityBase {
+    type?: 'file';
+    mimeType?: string;
+    size?: number;
+    contentHash?: string;
+    storagePath?: string;
+    content?: string | null;
+    frontmatter?: unknown;
+}
+export interface FolderEntity extends EntityBase {
+    type: 'folder';
+}
+export type Entity = FileEntity | FolderEntity;
+export interface OrgMembership {
+    orgId: string;
+    orgName: string;
+    role: string;
+    memberId: string;
+}
+export interface OrgMember {
+    id: string;
+    orgId?: string;
+    userId?: string;
+    email?: string;
+    role?: string;
+    orgName?: string;
+}
+export interface Team {
+    id: string;
+    name?: string;
+    isDefault?: boolean;
+    createdBy?: string;
+    createdAt?: string;
+}
+export interface TeamMember {
+    id: string;
+    teamId?: string;
+    userId?: string;
+    email?: string;
+    role?: string;
+}
+export interface UserProfile {
+    orgCount?: number;
+}
+export {};
+//# sourceMappingURL=firestore.d.ts.map

package/dist/firestore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"firestore.d.ts","sourceRoot":"","sources":["../src/firestore.ts"],"names":[],"mappings":"AAoBA,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,SAAS,CAAC;AAKvC,UAAU,UAAU;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC7B;AASD,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAGD,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,IAAI,EAAE,QAAQ,CAAC;CAChB;AAID,MAAM,MAAM,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC;AAM/C,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CAClB;AAKD,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAGD,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAGD,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAKD,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/dist/firestore.js

@@ -0,0 +1,16 @@
+// Firestore document interfaces shared between web/ and sync/.
+//
+// These shapes are the contract for what each collection stores. Both
+// readers (web's loadFiles, sync's onSnapshot listeners) and writers
+// (web's createNewFile, sync's pushFileToCloud) import these so a
+// schema change can never silently diverge between the two halves of
+// the system.
+//
+// Field optionality reflects on-disk reality:
+//   - id is always present (it's the doc id, not a field).
+//   - Fields written by both web and sync are required.
+//   - Fields written by one side only or only on certain entity types
+//     are optional (e.g., ownerId is null on team files, parentId is
+//     null at the root).
+export {};
+//# sourceMappingURL=firestore.js.map

package/dist/firestore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"firestore.js","sourceRoot":"","sources":["../src/firestore.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,EAAE;AACF,sEAAsE;AACtE,qEAAqE;AACrE,kEAAkE;AAClE,qEAAqE;AACrE,cAAc;AACd,EAAE;AACF,8CAA8C;AAC9C,2DAA2D;AAC3D,wDAAwD;AACxD,sEAAsE;AACtE,qEAAqE;AACrE,yBAAyB"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './firestore.js';
+export * from './mime.js';
+export * from './paths.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,10 @@
+// Public entry. Consumers import everything via `@doubling/types`.
+//
+// NodeNext module resolution requires the `.js` extension on
+// relative imports in TypeScript source, even though the actual file
+// on disk is `.ts`. tsc and Node's ESM loader rewrite to the
+// compiled `.js` at build / runtime.
+export * from './firestore.js';
+export * from './mime.js';
+export * from './paths.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,EAAE;AACF,6DAA6D;AAC7D,qEAAqE;AACrE,6DAA6D;AAC7D,qCAAqC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC"}

package/dist/mime.d.ts

@@ -0,0 +1,4 @@
+export declare const EXT_TO_MIME: Record<string, string>;
+export declare function mimeTypeFromExt(ext: string | null | undefined): string;
+export declare function isTextMimeType(mimeType: string | null | undefined): boolean;
+//# sourceMappingURL=mime.d.ts.map

package/dist/mime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mime.d.ts","sourceRoot":"","sources":["../src/mime.ts"],"names":[],"mappings":"AAaA,eAAO,MAAM,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CA0C9C,CAAC;AAEF,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAGtE;AASD,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAG3E"}

package/dist/mime.js

@@ -0,0 +1,73 @@
+// Single source of truth for file-extension to MIME-type mapping.
+//
+// Previously duplicated in `web/src/storage-helpers.ts` and
+// `sync/storage-helpers.js`. The duplication had bitten us multiple
+// times: a new text extension added on one side but not the other
+// caused the daemon to upload with `application/octet-stream`, and
+// the web's eager-load path then skipped the file because it didn't
+// recognise the type. DOU-182 collapses both copies to this module.
+//
+// To add a new extension: edit the `EXT_TO_MIME` table here and
+// (where the extension is text) verify `isTextMimeType` returns
+// true for the resulting mime. No other file needs to change.
+export const EXT_TO_MIME = {
+    md: 'text/markdown',
+    markdown: 'text/markdown',
+    txt: 'text/plain',
+    csv: 'text/csv',
+    html: 'text/html',
+    htm: 'text/html',
+    css: 'text/css',
+    js: 'text/javascript',
+    // Obsidian Bases (.base) files are YAML. Mapped to text/yaml so
+    // the web's eager-load path treats them as text and the Bases
+    // renderer can read entity.content at page-render time.
+    base: 'text/yaml',
+    yaml: 'text/yaml',
+    yml: 'text/yaml',
+    json: 'application/json',
+    pdf: 'application/pdf',
+    png: 'image/png',
+    jpg: 'image/jpeg',
+    jpeg: 'image/jpeg',
+    gif: 'image/gif',
+    webp: 'image/webp',
+    svg: 'image/svg+xml',
+    bmp: 'image/bmp',
+    heic: 'image/heic',
+    heif: 'image/heif',
+    mp3: 'audio/mpeg',
+    wav: 'audio/wav',
+    mp4: 'video/mp4',
+    webm: 'video/webm',
+    mov: 'video/quicktime',
+    zip: 'application/zip',
+    // Office Open XML (modern Office). The full type strings are
+    // mandatory: tools that dispatch by mime (Excel, third-party
+    // readers) ignore alternative spellings.
+    xlsx: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+    docx: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+    pptx: 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+    // Legacy Office formats (pre-2007 binary containers).
+    xls: 'application/vnd.ms-excel',
+    doc: 'application/msword',
+    ppt: 'application/vnd.ms-powerpoint',
+};
+export function mimeTypeFromExt(ext) {
+    if (ext == null)
+        return 'application/octet-stream';
+    return EXT_TO_MIME[String(ext).toLowerCase()] || 'application/octet-stream';
+}
+// Files of these mime types are treated as inline-readable text by
+// the sync daemon (read with utf-8 encoding from disk, written with
+// utf-8 encoding to disk) and by web's loadFiles (eager-fetched into
+// entity.content). Everything else is binary, downloaded on demand.
+//
+// Missing mime type is treated as text for backward compatibility
+// with markdown files written before the mime type was tracked.
+export function isTextMimeType(mimeType) {
+    if (mimeType == null || mimeType === '')
+        return true;
+    return typeof mimeType === 'string' && mimeType.startsWith('text/');
+}
+//# sourceMappingURL=mime.js.map

package/dist/mime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mime.js","sourceRoot":"","sources":["../src/mime.ts"],"names":[],"mappings":"AAAA,kEAAkE;AAClE,EAAE;AACF,4DAA4D;AAC5D,oEAAoE;AACpE,kEAAkE;AAClE,mEAAmE;AACnE,oEAAoE;AACpE,oEAAoE;AACpE,EAAE;AACF,gEAAgE;AAChE,gEAAgE;AAChE,8DAA8D;AAE9D,MAAM,CAAC,MAAM,WAAW,GAA2B;IACjD,EAAE,EAAE,eAAe;IACnB,QAAQ,EAAE,eAAe;IACzB,GAAG,EAAE,YAAY;IACjB,GAAG,EAAE,UAAU;IACf,IAAI,EAAE,WAAW;IACjB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,UAAU;IACf,EAAE,EAAE,iBAAiB;IACrB,gEAAgE;IAChE,8DAA8D;IAC9D,wDAAwD;IACxD,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,WAAW;IACjB,GAAG,EAAE,WAAW;IAChB,IAAI,EAAE,kBAAkB;IACxB,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,YAAY;IACjB,IAAI,EAAE,YAAY;IAClB,GAAG,EAAE,WAAW;IAChB,IAAI,EAAE,YAAY;IAClB,GAAG,EAAE,eAAe;IACpB,GAAG,EAAE,WAAW;IAChB,IAAI,EAAE,YAAY;IAClB,IAAI,EAAE,YAAY;IAClB,GAAG,EAAE,YAAY;IACjB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,WAAW;IAChB,IAAI,EAAE,YAAY;IAClB,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,iBAAiB;IACtB,6DAA6D;IAC7D,6DAA6D;IAC7D,yCAAyC;IACzC,IAAI,EAAE,mEAAmE;IACzE,IAAI,EAAE,yEAAyE;IAC/E,IAAI,EAAE,2EAA2E;IACjF,sDAAsD;IACtD,GAAG,EAAE,0BAA0B;IAC/B,GAAG,EAAE,oBAAoB;IACzB,GAAG,EAAE,+BAA+B;CACrC,CAAC;AAEF,MAAM,UAAU,eAAe,CAAC,GAA8B;IAC5D,IAAI,GAAG,IAAI,IAAI;QAAE,OAAO,0BAA0B,CAAC;IACnD,OAAO,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,0BAA0B,CAAC;AAC9E,CAAC;AAED,mEAAmE;AACnE,oEAAoE;AACpE,qEAAqE;AACrE,oEAAoE;AACpE,EAAE;AACF,kEAAkE;AAClE,gEAAgE;AAChE,MAAM,UAAU,cAAc,CAAC,QAAmC;IAChE,IAAI,QAAQ,IAAI,IAAI,IAAI,QAAQ,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IACrD,OAAO,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AACtE,CAAC"}

package/dist/paths.d.ts

@@ -0,0 +1,3 @@
+export declare function extFromPath(path: string | null | undefined): string;
+export declare function storagePathFor(orgId: string, fileId: string, ext: string | null | undefined): string;
+//# sourceMappingURL=paths.d.ts.map

package/dist/paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../src/paths.ts"],"names":[],"mappings":"AAWA,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAKnE;AAID,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAEpG"}

package/dist/paths.js

@@ -0,0 +1,23 @@
+// Pure path helpers, environment-agnostic. No fs, no Firebase.
+//
+// Lives in @doubling/types (alongside the MIME helpers) because both
+// web and sync derive Cloud Storage paths and extension strings from
+// these, and they must agree on the convention. The function bodies
+// are intentionally simple so the two sides cannot diverge by
+// accident on an edge case.
+// Extract the file extension (lowercased) from a path. Returns 'bin'
+// for paths with no extension or where the dot is the first or last
+// character (dotfiles, trailing dots).
+export function extFromPath(path) {
+    const name = (((path == null ? '' : path) + '').split('/').pop()) || '';
+    const idx = name.lastIndexOf('.');
+    if (idx <= 0 || idx === name.length - 1)
+        return 'bin';
+    return name.slice(idx + 1).toLowerCase();
+}
+// Build the canonical Cloud Storage path for a file's content blob.
+// Layout: orgs/{orgId}/files/{fileId}/current.{ext}
+export function storagePathFor(orgId, fileId, ext) {
+    return `orgs/${orgId}/files/${fileId}/current.${ext || 'bin'}`;
+}
+//# sourceMappingURL=paths.js.map

package/dist/paths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.js","sourceRoot":"","sources":["../src/paths.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,EAAE;AACF,qEAAqE;AACrE,qEAAqE;AACrE,oEAAoE;AACpE,8DAA8D;AAC9D,4BAA4B;AAE5B,qEAAqE;AACrE,oEAAoE;AACpE,uCAAuC;AACvC,MAAM,UAAU,WAAW,CAAC,IAA+B;IACzD,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC;IACxE,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAClC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IACtD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;AAC3C,CAAC;AAED,oEAAoE;AACpE,oDAAoD;AACpD,MAAM,UAAU,cAAc,CAAC,KAAa,EAAE,MAAc,EAAE,GAA8B;IAC1F,OAAO,QAAQ,KAAK,UAAU,MAAM,YAAY,GAAG,IAAI,KAAK,EAAE,CAAC;AACjE,CAAC"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@doubling/types",
+  "version": "0.1.0",
+  "description": "Shared Firestore document interfaces and MIME / path helpers consumed by web/ and sync/. Single source of truth so the two consumers can never drift on a document shape (DOU-182, TS Phase 2 of the monorepo TypeScript migration).",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist/",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "prepare": "tsc",
+    "prepack": "tsc"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Doubling-Inc/doubling-compound.git",
+    "directory": "types"
+  },
+  "bugs": {
+    "url": "https://github.com/Doubling-Inc/doubling-compound/issues"
+  },
+  "homepage": "https://github.com/Doubling-Inc/doubling-compound/tree/main/types#readme",
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public"
+  }
+}