@pocketstock/types 0.1.0 → 0.2.0

package/README.md

@@ -2,17 +2,32 @@
 
 Shared contracts package for PocketStock repositories.
 
+## Week 3-4 Contract Set
+
+- `core` primitives
+- API envelopes
+- sync metadata/contracts
+- auth contracts (`register`, `pin-login`, `refresh`, `logout`, `session`)
+- product/category contracts
+- asset upload metadata contracts
+
 ## Release Policy
 
 - Semver is required.
 - Breaking contract changes require a major version bump.
-- `pocketstock-api` and `pocketstock-mobile` must pin exact versions.
+- `pocketstock-api` and `pocketstock-mobile` must pin exact versions (no ranges).
+- Every release must include a matching `CHANGELOG.md` entry.
 
 ## Publish
 
 1. Bump version (`npm version patch|minor|major`).
 2. Push commit and tag.
-3. CI publish workflow runs on `v*` tags.
+3. Validate package:
+   - `npm run typecheck`
+   - `npm run build`
+   - `npm test`
+   - `npm run pack:check`
+4. CI publish workflow runs on `v*` tags.
 
 ## Versioning Order
 

package/dist/asset.d.ts

@@ -0,0 +1,16 @@
+export type WorkerUploadMetadata = {
+    key: string;
+    url: string;
+    etag?: string;
+    size: number;
+    contentType: string;
+};
+export type UploadProductImageRequest = {
+    filename: string;
+    contentType: string;
+    size: number;
+};
+export type UploadProductImageResponse = {
+    image: WorkerUploadMetadata;
+};
+//# sourceMappingURL=asset.d.ts.map

package/dist/asset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset.d.ts","sourceRoot":"","sources":["../src/asset.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,oBAAoB,GAAG;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE,oBAAoB,CAAC;CAC7B,CAAC"}

package/dist/asset.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=asset.js.map

package/dist/asset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset.js","sourceRoot":"","sources":["../src/asset.ts"],"names":[],"mappings":""}

package/dist/auth.d.ts

@@ -0,0 +1,46 @@
+import type { IsoDateTime, ShopId, UserId } from "./core.js";
+export type RegisterRequest = {
+    shopName: string;
+    ownerName: string;
+    pin: string;
+    phone?: string;
+    email?: string;
+};
+export type PinLoginRequest = {
+    shopCode: string;
+    pin: string;
+    deviceName?: string;
+    platform?: string;
+};
+export type RefreshRequest = {
+    refreshToken: string;
+};
+export type LogoutRequest = {
+    refreshToken: string;
+};
+export type AuthShop = {
+    id: ShopId;
+    code: string;
+    name: string;
+    currency: string;
+    timezone: string;
+};
+export type AuthUser = {
+    id: UserId;
+    shopId: ShopId;
+    role: "OWNER" | "MANAGER" | "CASHIER" | "STOCKIST";
+    displayName: string;
+    phone?: string;
+    email?: string;
+};
+export type AuthSession = {
+    accessToken: string;
+    refreshToken: string;
+    expiresAt: IsoDateTime;
+};
+export type AuthResponse = {
+    shop: AuthShop;
+    user: AuthUser;
+    session: AuthSession;
+};
+//# sourceMappingURL=auth.d.ts.map

package/dist/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAE7D,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;IACnD,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,WAAW,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,WAAW,CAAC;CACtB,CAAC"}

package/dist/auth.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=auth.js.map

package/dist/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -1,4 +1,7 @@
 export * from "./core.js";
 export * from "./api.js";
 export * from "./sync.js";
+export * from "./auth.js";
+export * from "./product.js";
+export * from "./asset.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -1,4 +1,7 @@
 export * from "./core.js";
 export * from "./api.js";
 export * from "./sync.js";
+export * from "./auth.js";
+export * from "./product.js";
+export * from "./asset.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC"}

package/dist/product.d.ts

@@ -0,0 +1,71 @@
+import type { CurrencyCode, IsoDateTime, PageInfo, ProductId } from "./core.js";
+export type CategoryDto = {
+    id: string;
+    name: string;
+    description?: string;
+    isActive: boolean;
+    createdAt: IsoDateTime;
+    updatedAt: IsoDateTime;
+};
+export type CreateCategoryRequest = {
+    name: string;
+    description?: string;
+};
+export type UpdateCategoryRequest = {
+    name?: string;
+    description?: string;
+    isActive?: boolean;
+};
+export type ProductDto = {
+    id: ProductId;
+    name: string;
+    description?: string;
+    sku?: string;
+    barcode?: string;
+    categoryId?: string;
+    buyPriceMinor: number;
+    sellPriceMinor: number;
+    currency: CurrencyCode;
+    quantityOnHand: number;
+    reorderLevel: number;
+    trackExpiry: boolean;
+    isActive: boolean;
+    imageUrl?: string;
+    imageKey?: string;
+    createdAt: IsoDateTime;
+    updatedAt: IsoDateTime;
+};
+export type CreateProductRequest = {
+    name: string;
+    description?: string;
+    sku?: string;
+    barcode?: string;
+    categoryId?: string;
+    buyPriceMinor: number;
+    sellPriceMinor: number;
+    reorderLevel?: number;
+    trackExpiry?: boolean;
+};
+export type UpdateProductRequest = {
+    name?: string;
+    description?: string;
+    sku?: string;
+    barcode?: string;
+    categoryId?: string;
+    buyPriceMinor?: number;
+    sellPriceMinor?: number;
+    reorderLevel?: number;
+    trackExpiry?: boolean;
+    isActive?: boolean;
+};
+export type ProductListQuery = {
+    q?: string;
+    categoryId?: string;
+    page?: number;
+    pageSize?: number;
+};
+export type ProductListResponse = {
+    data: ProductDto[];
+    pageInfo: PageInfo;
+};
+//# sourceMappingURL=product.d.ts.map

package/dist/product.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"product.d.ts","sourceRoot":"","sources":["../src/product.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEhF,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,WAAW,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,EAAE,SAAS,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,YAAY,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,WAAW,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,UAAU,EAAE,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC"}

package/dist/product.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=product.js.map

package/dist/product.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"product.js","sourceRoot":"","sources":["../src/product.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pocketstock/types",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Shared contracts for PocketStock mobile and API",
   "license": "MIT",
   "publishConfig": {
@@ -20,9 +20,13 @@
     "build": "tsc -p tsconfig.build.json",
     "typecheck": "tsc --noEmit -p tsconfig.json",
     "lint": "tsc --noEmit -p tsconfig.json",
-    "test": "node --test"
+    "test:runtime": "npm run build && vitest run tests/runtime-smoke.test.ts",
+    "test:types": "tsc --noEmit -p tests/tsconfig.json",
+    "test": "npm run test:runtime && npm run test:types",
+    "pack:check": "npm pack --dry-run --cache ../.npm-cache"
   },
   "devDependencies": {
-    "typescript": "^5.6.3"
+    "typescript": "^5.6.3",
+    "vitest": "^4.0.8"
   }
 }