feat(Invoice): add Invoice base type

- add paymentPlannedMoment
- add todo notes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "moysklad-api-model",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Объектная модель API МойСклад для TypeScript проектов",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",

src/model/Invoice.ts

@@ -0,0 +1,25 @@
+import type {
+  DocumentWithPositions,
+  DocumentWithPositionsPatch,
+  HasVat,
+  HasVatPatch
+} from '.'
+
+export type InvoiceMetaType = 'invoicein' | 'invoiceout'
+
+export type InvoiceFields = {
+  paymentPlannedMoment?: string
+
+  readonly payedSum: number
+
+  readonly shippedSum: number
+}
+
+export type Invoice<T extends InvoiceMetaType> = DocumentWithPositions<T> &
+  HasVat
+
+export type InvoicePatch<
+  T extends InvoiceMetaType
+> = DocumentWithPositionsPatch<T> &
+  Partial<Pick<InvoiceFields, 'paymentPlannedMoment'>> &
+  HasVatPatch

src/model/InvoiceIn.ts

@@ -1,11 +1,15 @@
-import type {
-  DocumentWithPositions,
-  DocumentWithPositionsPatch,
-  HasVat,
-  HasVatPatch
-} from '.'
+import type { EntityRef, Invoice, InvoicePatch } from '.'
 
-export type InvoiceIn = DocumentWithPositions<'invoicein'> & HasVat
+export type InvoiceInFields = {
+  purchaseOrder?: EntityRef<'purchaseorder'>
 
-export type InvoiceInPatch = DocumentWithPositionsPatch<'invoicein'> &
-  HasVatPatch
+  // TODO incomingDate: DateTime
+  // TODO financesOut: IDREF
+  // TODO incomingNumber: String
+  // TODO supplies: IDREF
+}
+
+export type InvoiceIn = Invoice<'invoicein'>
+
+export type InvoiceInPatch = InvoicePatch<'invoicein'> &
+  Partial<Pick<InvoiceInFields, 'purchaseOrder'>>

src/model/InvoiceOut.ts

@@ -1,21 +1,13 @@
-import type {
-  DocumentWithPositions,
-  DocumentWithPositionsPatch,
-  HasVat,
-  HasVatPatch
-} from '.'
-import type { EntityRef } from './EntityRef'
+import type { EntityRef, Invoice, InvoicePatch } from '.'
 
 export type InvoiceOutFields = {
   customerOrder?: EntityRef<'customerorder'>
-  readonly payedSum: number
-  readonly shippedSum: number
+
+  // TODO demands
+  // TODO payments
 }
 
-export type InvoiceOut = DocumentWithPositions<'invoiceout'> &
-  HasVat &
-  InvoiceOutFields
+export type InvoiceOut = Invoice<'invoiceout'> & InvoiceOutFields
 
-export type InvoiceOutPatch = DocumentWithPositionsPatch<'invoiceout'> &
-  HasVatPatch &
+export type InvoiceOutPatch = InvoicePatch<'invoiceout'> &
   Partial<Pick<InvoiceOutFields, 'customerOrder'>>

src/model/index.ts

@@ -33,6 +33,7 @@ export * from './HasState'
 export * from './HasStore'
 export * from './HasUpdated'
 export * from './HasVat'
+export * from './Invoice'
 export * from './InvoiceIn'
 export * from './InvoiceOut'
 export * from './InvoicePosition'