@unimicro/platform-types 0.1.1 → 0.1.2

package/README.md

@@ -1,59 +1,22 @@
 # @unimicro/platform-types
 
-Type declarations for the Unimicro Platform's business entities — customers, invoices, accounts,
-employees, and the several hundred others. Types only: this package ships no JavaScript, and
-everything in it erases at build.
+Type declarations for the Unimicro platform's business entities — customers, invoices, accounts,
+employees and the several hundred others. Types only: the package contains no JavaScript.
 
-```sh
+```bash
 npm install --save-dev @unimicro/platform-types
 ```
 
-## Using it from a plugin
+Generated from the platform's own model and republished when the model moves, so it is neither
+hand-written nor hand-curated. The declarations describe the platform rather than any one company:
+custom fields do not appear, and arrive under `CustomValues` at runtime.
 
-The host API client takes the entity route as a string and returns whatever you type it as:
+Each entity carries the route it answers on as a literal type, because an entity's name and its
+route are often not the same word.
 
-```ts
-import type { Customer } from '@unimicro/platform-types';
+Dates and times are string aliases — `LocalDate` is `"2026-09-02"`, which is what the API sends —
+so they read and write as strings without a cast. The alias names the format; it does not stop a
+plain string from being assigned.
 
-const customers = await host.api.get<Partial<Customer>[]>('customers', {
-    expand: 'Info',
-    select: 'ID,CustomerNumber,Info.Name',
-});
-```
-
-**`Partial`, not the entity itself.** `select` trims the payload, so typing a selected response as a
-whole `Customer` claims fifty fields the object does not have — and the editor then autocompletes
-every one of them, which is worse than no types at all. `Partial` still refuses a field the entity
-does not have, which is the mistake worth catching, while leaving presence to the query.
-
-A query with no `select` returns the whole entity and can be typed as one.
-
-## Routes are in the types
-
-Every entity carries the route it answers on as a literal type:
-
-```ts
-type InvoiceRoute = typeof CustomerInvoice.RelativeUrl; // 'invoices' — not 'customerinvoices'
-```
-
-Worth reading before writing a call. An entity's name and its route are often not the same word, and
-a plausible guess returns a 404 that says nothing about why.
-
-**This is a type, not a value.** The package ships no JavaScript, so `CustomerInvoice.RelativeUrl`
-cannot be read at runtime — pass the route as a string and let the literal above be what tells you
-which string. The literal is there so that a typed client can one day infer the route from the
-entity rather than being handed both.
-
-## Where this comes from
-
-The platform generates these from its own model, and this package is that output as declarations,
-republished whenever the model moves. It is not hand-written and not hand-curated: if an entity is
-in the platform, it is here, and if a field is missing here it is missing there too.
-
-Two consequences of that worth knowing. Fields are non-optional in the declarations because the
-model declares them so, which is why `Partial` does the work above. And the types describe the
-platform, not any one company — custom fields do not appear, and arrive under `CustomValues` at
-runtime.
-
-For what the fields _mean_ — what a status integer says, which relations have to be expanded, what
-the query syntax accepts — see the `platform-api` skill that ships with the Unimicro CLI.
+For what the fields mean — status values, which relations expand, the query syntax — see the
+`platform-api` skill that ships with the Unimicro CLI.

package/index.d.ts

@@ -1,23 +1,12 @@
 // Generated from the Unimicro Platform model. Do not edit.
 //
 // Source: https://test-api.unimicro.no/api/metadata/typescriptentities
-// Fetched: {fetched}
-export declare class LocalDate {
-    private value;
-    year: number;
-    month: number;
-    day: number;
-    constructor(value?: string | Date);
-    toJSON(): string;
-    toDate(): Date;
-    toString(): string;
-}
-export declare class LocalTime {
-    private value;
-    constructor(value: string);
-    toJSON(): string;
-    toString(): string;
-}
+export type LocalDate = string & {
+    readonly __localDate?: never;
+};
+export type LocalTime = string & {
+    readonly __localTime?: never;
+};
 export declare class UniEntity {
 }
 export declare class A06Options extends UniEntity {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@unimicro/platform-types",
-    "version": "0.1.1",
+    "version": "0.1.2",
     "description": "Type declarations for the Unimicro Platform's business entities. Generated from the platform's own model — types only, this package ships no JavaScript.",
     "types": "index.d.ts",
     "files": [