@unimicro/platform-types 0.1.1

package/LICENSE

@@ -0,0 +1,238 @@
+UNIMICRO PLATFORM SDK LICENCE
+Version 1.0 – 2026
+
+Copyright (c) 2026 Unimicro AS. All rights reserved.
+
+
+1. DEFINITIONS
+
+“Software” means the Unimicro Platform SDK package supplied with this Licence,
+including its source code, object code, type declarations, examples and
+documentation, but excluding Third-Party Components identified by a separate
+licence or notice.
+
+“Unimicro Platform” means the software and services operated or supplied by or
+on behalf of Unimicro AS, including its web applications, APIs, developer
+services, plugin runtime and any partner-branded or white-labelled instances
+supplied by Unimicro AS.
+
+“Integration” means software or a service developed by or for You that is
+designed to run inside, extend or communicate with the Unimicro Platform through
+interfaces made available or authorised by Unimicro AS. An Integration includes
+a plugin and an application or service that calls Unimicro Platform APIs.
+
+“You” means the individual or legal entity exercising rights under this Licence.
+
+
+2. ACCEPTANCE
+
+By using, copying, modifying or distributing the Software, You accept the terms
+of this Licence.
+
+If You do not accept these terms, You may not use, copy, modify or distribute
+the Software.
+
+
+3. GRANT
+
+Subject to the terms of this Licence, Unimicro AS grants You a perpetual,
+worldwide, royalty-free, non-exclusive licence to:
+
+(a) use and copy the Software;
+
+(b) modify the Software;
+
+(c) use the Software to build, test, operate, maintain and support an
+    Integration; and
+
+(d) distribute the Software, in source code or object code form, as an
+    incorporated, bundled or otherwise necessary part of an Integration.
+
+These rights are granted solely for the purpose of developing, testing,
+operating, maintaining, supporting or distributing an Integration.
+
+You may use the Software inside Your own organisation and distribute or make
+Your Integration available to others, including commercially.
+
+Your employees and contractors may exercise these rights on Your behalf,
+provided that You remain responsible for their compliance with this Licence.
+
+The rights granted under this Licence may not otherwise be assigned or
+sublicensed. You may, however, transfer this Licence as part of a merger,
+acquisition, corporate reorganisation or transfer of substantially all assets
+relating to the Integration, provided that the recipient accepts this Licence.
+
+
+4. DISTRIBUTION
+
+You may distribute the Software only as an incorporated, bundled or otherwise
+necessary part of an Integration.
+
+When distributing an Integration that contains the Software or a substantial
+portion of it, You must:
+
+(a) include a copy of this Licence;
+
+(b) retain all applicable copyright, attribution and legal notices contained in
+    the Software;
+
+(c) clearly identify files containing material modifications made by You, where
+    reasonably practicable; and
+
+(d) not impose terms that restrict or contradict the rights granted under this
+    Licence with respect to the Software.
+
+You may apply any licence terms You choose to Your own Integration, provided
+that those terms do not claim ownership of the Software or alter the terms that
+apply to the Software.
+
+You may also make copies of the Software in internal package registries, caches,
+development environments and CI/CD systems where this is reasonably necessary
+to build, test, operate or maintain an Integration.
+
+
+5. RESTRICTIONS
+
+You may not:
+
+(a) use the Software for any purpose other than the purposes granted in
+    section 3;
+
+(b) distribute, sell, license or otherwise make the Software available on its
+    own, except for internal copies permitted under section 4;
+
+(c) distribute the Software as part of software or a service that is not an
+    Integration;
+
+(d) remove, conceal or alter any copyright, attribution or legal notice
+    contained in the Software;
+
+(e) use Unimicro’s names, logos, trademarks or other brand elements except to
+    state accurately that Your Integration works with the Unimicro Platform; or
+
+(f) state or imply that Unimicro AS has approved, certified, endorsed or
+    sponsored Your Integration unless Unimicro AS has confirmed this in writing.
+
+Any permitted use of Unimicro names or trademarks must comply with applicable
+Unimicro brand and trademark guidelines.
+
+
+6. PLATFORM ACCESS AND OTHER TERMS
+
+This Licence governs the Software only.
+
+It does not grant You access to the Unimicro Platform, its APIs, plugin runtime,
+Marketplace, developer accounts, customer data or other Unimicro services.
+
+Access to and use of the Unimicro Platform may be subject to separate developer
+terms, API terms, Marketplace terms, security requirements, usage limits,
+commercial agreements or other applicable terms issued by Unimicro AS.
+
+Unimicro AS may suspend or terminate access to the Unimicro Platform in
+accordance with those separate terms, without terminating Your ownership of
+Your Integration.
+
+
+7. OWNERSHIP
+
+The Software is licensed, not sold. Unimicro AS retains all rights, title and
+interest in and to the Software that are not expressly granted under this
+Licence.
+
+You retain all rights in the original parts of Your Integration and in
+modifications authored by You.
+
+To the extent that Your modifications contain or are derived from the Software,
+Your use and distribution of those modifications remain subject to this
+Licence.
+
+Nothing in this Licence transfers ownership of Your Integration to Unimicro AS
+or grants Unimicro AS rights in the original parts of Your Integration.
+
+
+8. PATENTS AND THIRD-PARTY COMPONENTS
+
+To the extent that Unimicro AS controls patent claims that are necessarily
+infringed by the permitted use of the Software, Unimicro AS grants You a
+worldwide, royalty-free, non-exclusive patent licence limited to the activities
+permitted under this Licence.
+
+This patent licence terminates if You initiate patent proceedings alleging that
+the Software infringes a patent.
+
+Third-Party Components included in or distributed with the Software are governed
+by their respective licence terms. This Licence does not replace or modify those
+terms.
+
+
+9. NO WARRANTY OR SUPPORT OBLIGATION
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NON-INFRINGEMENT.
+
+UNIMICRO AS DOES NOT WARRANT THAT THE SOFTWARE WILL BE ERROR-FREE, SECURE,
+CONTINUOUSLY AVAILABLE OR COMPATIBLE WITH FUTURE VERSIONS OF THE UNIMICRO
+PLATFORM.
+
+Unless otherwise agreed in writing, Unimicro AS has no obligation to maintain,
+support, update or continue making the Software available.
+
+
+10. LIMITATION OF LIABILITY
+
+TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, UNIMICRO AS SHALL NOT BE
+LIABLE UNDER ANY LEGAL THEORY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+CONSEQUENTIAL OR EXEMPLARY DAMAGES, OR FOR ANY LOSS OF PROFITS, REVENUE,
+BUSINESS, GOODWILL OR DATA, ARISING OUT OF THIS LICENCE, THE SOFTWARE OR THE USE
+OF OR INABILITY TO USE THE SOFTWARE.
+
+Nothing in this Licence excludes or limits liability that cannot lawfully be
+excluded or limited.
+
+
+11. TERMINATION
+
+This Licence terminates if You materially breach its terms.
+
+If the breach can be remedied, termination takes effect only if You fail to
+remedy the breach within 10 days after becoming aware of it or receiving written
+notice from Unimicro AS.
+
+On termination, You must stop using, modifying and distributing the Software
+and remove copies under Your control, except for copies that must be retained by
+law or for internal archival purposes.
+
+You may not distribute new Integrations, new versions or updates containing the
+Software after termination.
+
+Termination of Your rights does not terminate the rights of recipients who
+received an Integration from You before termination, provided that those
+recipients continue to comply with this Licence. Their rights to included copies
+of the Software are granted directly by Unimicro AS under this Licence.
+
+Sections concerning ownership, warranties, liability, termination and governing
+law survive termination to the extent necessary to give them effect.
+
+
+12. GOVERNING LAW AND GENERAL TERMS
+
+This Licence is governed by the laws of Norway, without regard to
+conflict-of-law principles.
+
+Any dispute arising from this Licence shall be subject to the courts having
+jurisdiction at the registered office of Unimicro AS, unless mandatory law
+requires otherwise.
+
+If any provision of this Licence is found to be invalid or unenforceable, the
+remaining provisions remain in effect.
+
+Failure to enforce any provision of this Licence does not constitute a waiver of
+that provision.
+
+Nothing in this Licence limits any right that cannot lawfully be excluded by
+agreement.
+
+Unimicro AS may publish future versions of the Software under different licence
+terms. Such changes do not apply retroactively to a version of the Software that
+You already received under this Licence.

package/README.md

@@ -0,0 +1,59 @@
+# @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.
+
+```sh
+npm install --save-dev @unimicro/platform-types
+```
+
+## Using it from a plugin
+
+The host API client takes the entity route as a string and returns whatever you type it as:
+
+```ts
+import type { Customer } from '@unimicro/platform-types';
+
+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.