feat(PrefilledDocument): change and rename Template type interface

wmakeev · Jul 20, 2021 · c600599 · c600599
1 parent dd099ec
commit c600599
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 22 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "moysklad-api-model",
-  "version": "0.2.11",
+  "version": "0.3.0",
   "description": "Объектная модель API МойСклад для TypeScript проектов",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",

diff --git a/src/model/MetaType.ts b/src/model/MetaType.ts
@@ -9,6 +9,8 @@ import type {
   CustomerOrder,
   CustomerOrderPosition,
   Demand,
+  Document,
+  DocumentMetaType,
   Employee,
   Entity,
   Group,
@@ -19,6 +21,7 @@ import type {
   PaymentIn,
   PaymentOut,
   RetailDemand,
+  SelectKeysByType,
   State
 } from '.'
 
@@ -204,3 +207,11 @@ export type EntityByMetaType = {
   uom: Entity<'uom'>
   variant: Entity<'variant'>
 }
+
+/**
+ * MetaType документов для которых реализованы типы.
+ * */
+export type ImplementedDocumentsMetaType = SelectKeysByType<
+  EntityByMetaType,
+  Document<DocumentMetaType>
+>
diff --git a/src/model/api/endpoints.ts b/src/model/api/endpoints.ts
@@ -3,7 +3,12 @@ import type { Collection } from '../Collection'
 import type { CompanyMetaType } from '../Company'
 import type { Document, DocumentMetaType } from '../Document'
 import type { Meta } from '../Meta'
-import type { Expand, Patch, PatchCollection, Template } from '../utils'
+import type {
+  Expand,
+  Patch,
+  PatchCollection,
+  PrefilledDocument
+} from '../utils'
 import type { DomineEntityMetaType } from './types'
 
 export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE'
@@ -46,7 +51,7 @@ export type DomineEntityEndpoint<
   T extends DomineEntityMetaType = DomineEntityMetaType
 > = `entity/${T}/${Id}`
 
-export type DocumentTemplateEndpoint<
+export type PrefilledDocumentEndpoint<
   T extends DocumentMetaType = DocumentMetaType
 > = `entity/${T}/new`
 
@@ -80,7 +85,7 @@ export type HttpMethodPath = {
   POST: DomineEntityCollectionEndpoint | DocumentPositionCollectionEndpoint
 
   // TODO Какие точно типы поддерживают new?
-  PUT: DomineEntityEndpoint | DocumentTemplateEndpoint
+  PUT: DomineEntityEndpoint | PrefilledDocumentEndpoint
 
   DELETE: DomineEntityEndpoint
 }
@@ -127,7 +132,7 @@ export type EndpointInterface<
                       // TODO Для разных типов могут быть разные поля
                       any,
                       // TODO Не прописаны сущности для всех документов
-                      unknown, // Template<EntityByMetaType[EntityType]>,
+                      unknown, // PrefilledDocument<EntityByMetaType[EntityType]>,
                       ExpandStr
                     >
                   : never

diff --git a/src/model/utils/Template.ts → src/model/utils/PrefilledDocument.ts b/src/model/utils/Template.ts → src/model/utils/PrefilledDocument.ts
@@ -1,4 +1,9 @@
-import type { Document, DocumentMetaType } from '../Document'
+import type { DocumentWithPositionsMetaType } from '../DocumentWithPositions'
+import type {
+  EntityByMetaType,
+  ImplementedDocumentsMetaType
+} from '../MetaType'
+import type { Expand } from './Expand'
 
 // TODO Указать конкретные типы документов которые можно создавать этим методом
 
@@ -12,8 +17,10 @@ import type { Document, DocumentMetaType } from '../Document'
 /**
  * Шаблон нового документа `/entity/{type}/new`
  */
-export type Template<T extends Document<DocumentMetaType>> = Omit<
-  T,
+export type PrefilledDocument<T extends ImplementedDocumentsMetaType> = Omit<
+  T extends DocumentWithPositionsMetaType
+    ? Expand<EntityByMetaType[T], 'positions'>
+    : EntityByMetaType[T],
   'meta' | 'id' | 'accountId' | 'updated'
 >
 

diff --git a/src/model/utils/index.ts b/src/model/utils/index.ts
@@ -1,6 +1,6 @@
 export * from './Expand'
 export * from './Patch'
-export * from './Template'
+export * from './PrefilledDocument'
 
 // https://stackoverflow.com/questions/49579094/typescript-conditional-types-filter-out-readonly-properties-pick-only-requir
 
@@ -36,3 +36,7 @@ export type RequireKeys<T, K extends keyof T> = {
   {
     [P in K]-?: T[P]
   }
+
+export type SelectKeysByType<T, V> = {
+  [K in keyof T]: T[K] extends V ? K : never
+}[keyof T]
diff --git a/test/model/common.test.ts b/test/model/common.test.ts
@@ -1,4 +1,4 @@
-import type { InvoiceOut, Patch, Template } from '../../src'
+import type { Patch, PrefilledDocument } from '../../src'
 import { testTypeEqual } from '../tools'
 
 const customerorder: Patch<'customerorder'> = {}
@@ -10,7 +10,3 @@ const invoiceOut: Patch<'invoiceout'> = {}
 invoiceOut.positions?.[0].price
 invoiceOut.customerOrder
 invoiceOut.store
-
-const invoiceOutTemplate = {} as Template<InvoiceOut>
-
-invoiceOutTemplate.customerOrder
diff --git a/test/model/utils/PrefilledDocument.test.ts b/test/model/utils/PrefilledDocument.test.ts
@@ -0,0 +1,18 @@
+import type { PrefilledDocument } from '../../../src'
+
+const t1 = {} as PrefilledDocument<'customerorder'>
+
+// @ts-expect-error
+t1.id
+
+t1.agent.meta
+
+const invoiceOutPrefilled = {} as PrefilledDocument<'invoiceout'>
+
+invoiceOutPrefilled.customerOrder
+invoiceOutPrefilled.positions.rows[0].price
+
+const cashinPrefilled = {} as PrefilledDocument<'cashin'>
+
+const incomingDate1: string | undefined = cashinPrefilled.incomingDate
+incomingDate1
diff --git a/test/model/utils/Template.test.ts b/test/model/utils/Template.test.ts