feat: работа над моделью

- изменение MetaType на Union из строк
- добавление срезов полей сущностей для преобразований с Expand и Patch
- описание точек доступа API по методам
- доработка Expand
- изменение Patch на более простую структуру
- прочие доработки и тестирование

TODO.md

@@ -5,3 +5,10 @@
     ```ts
     Expand<CustomerOrder, 'agent.group,state'>
     ```
+- [ ] Подумать как работать с обобщенными запросами
+
+    ```ts
+    ms.GET(nextHref, query)
+    ```
+
+- [ ] Нужен еще один слой Create как и для Patch?

package.json

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

src/model/Account.ts

@@ -1,8 +1,7 @@
 import type { Entity } from './Entity'
 import type { HasUpdated } from './HasUpdated'
-import type { MetaType } from './MetaType'
 
-export interface Account extends Entity<MetaType.Account>, HasUpdated {
+export interface Account extends Entity<'account'>, HasUpdated {
   /** Является ли счет основным счетом Контрагента */
   isDefault: boolean
 

src/model/Address.ts

@@ -4,9 +4,9 @@ import type { MetaType } from './MetaType'
 export interface Address {
   postalCode?: string
 
-  country?: EntityRef<MetaType.Country>
+  country?: EntityRef<'country'>
 
-  region?: EntityRef<MetaType.Region>
+  region?: EntityRef<'region'>
 
   city?: string
 

src/model/Agent.ts

@@ -2,13 +2,9 @@ import type { Entity } from './Entity'
 import type { HasAttributes } from './HasAttributes'
 import type { HasCreated } from './HasCreated'
 import type { HasUpdated } from './HasUpdated'
-import type { MetaType } from './MetaType'
 import type { Owned } from './Owned'
 
-export type AgentMetaType =
-  | MetaType.Employee
-  | MetaType.Counterparty
-  | MetaType.Organization
+export type AgentMetaType = 'employee' | 'counterparty' | 'organization'
 
 export interface Agent<T extends AgentMetaType>
   extends Entity<T>,

src/model/AgentNote.ts

@@ -3,10 +3,10 @@ import type { EntityRef } from './EntityRef'
 import type { HasCreated } from './HasCreated'
 import type { MetaType } from './MetaType'
 
-export interface AgentNote extends Entity<MetaType.Note>, HasCreated {
+export interface AgentNote extends Entity<'note'>, HasCreated {
   description?: string
 
-  agent: EntityRef<MetaType.Counterparty>
+  agent: EntityRef<'counterparty'>
 
-  author: EntityRef<MetaType.Employee>
+  author: EntityRef<'employee'>
 }

src/model/Attribute.ts

@@ -1,7 +1,6 @@
 import type { Entity } from './Entity'
-import type { EntityRef } from './EntityRef'
+import type { EntityPatchRef, EntityRef } from './EntityRef'
 import type { MediaType } from './MediaType'
-import type { MetaType } from './MetaType'
 
 export enum AttributeType {
   // Base type
@@ -39,22 +38,22 @@ export type AttributeJsTypeMap = {
   [AttributeType.Link]: string
 
   // Embedded entity
-  [AttributeType.Organization]: EntityRef<MetaType.Organization>
-  [AttributeType.Counterparty]: EntityRef<MetaType.Counterparty>
-  [AttributeType.Employee]: EntityRef<MetaType.Employee>
-  [AttributeType.Contract]: EntityRef<MetaType.Contract>
-  [AttributeType.Product]: EntityRef<MetaType.Product>
-  [AttributeType.Project]: EntityRef<MetaType.Project>
-  [AttributeType.Store]: EntityRef<MetaType.Store>
+  [AttributeType.Organization]: EntityRef<'organization'>
+  [AttributeType.Counterparty]: EntityRef<'counterparty'>
+  [AttributeType.Employee]: EntityRef<'employee'>
+  [AttributeType.Contract]: EntityRef<'contract'>
+  [AttributeType.Product]: EntityRef<'product'>
+  [AttributeType.Project]: EntityRef<'project'>
+  [AttributeType.Store]: EntityRef<'store'>
 
   // Custom entity
-  [AttributeType.CustomEntity]: EntityRef<MetaType.CustomEntity> & {
+  [AttributeType.CustomEntity]: EntityRef<'customentity'> & {
     readonly name: string
   }
 }
 
 export interface AttributeBase<T extends AttributeType = AttributeType>
-  extends Entity<MetaType.AttributeMetadata> {
+  extends Entity<'attributemetadata'> {
   /** Наименование пользовательского поля */
   readonly name: string
 
@@ -74,3 +73,8 @@ export type Attribute<
       }
     }
   : AttributeBase<T>
+
+export type AttributePatch<T extends AttributeType = AttributeType> = Partial<
+  Pick<Attribute<T>, 'value'>
+> &
+  EntityPatchRef<'attributemetadata'>

src/model/CashIn.ts

@@ -0,0 +1,5 @@
+import type { FinanceIn, FinanceInPatch } from './FinanceIn'
+
+export type CashIn = FinanceIn<'cashin'>
+
+export type CashInPatch = FinanceInPatch

src/model/CashOut.ts

@@ -0,0 +1,5 @@
+import type { FinanceOut, FinanceOutPatch } from './FinanceOut'
+
+export type CashOut = FinanceOut<'cashout'>
+
+export type CashOutPatch = FinanceOutPatch

src/model/Company.ts

@@ -4,7 +4,7 @@ import type { CollectionRef } from './CollectionRef'
 import type { EntityRef } from './EntityRef'
 import type { MetaType } from './MetaType'
 
-export type CompanyMetaType = MetaType.Counterparty | MetaType.Organization
+export type CompanyMetaType = 'counterparty' | 'organization'
 
 export enum CompanyType {
   Legal = 'legal',
@@ -13,7 +13,7 @@ export enum CompanyType {
 }
 
 export interface CompanyDiscountData {
-  discount: EntityRef<MetaType.Discount>
+  discount: EntityRef<'discount'>
 
   personalDiscount: number // double
 
@@ -28,7 +28,7 @@ export interface Company<T extends CompanyMetaType> extends Agent<T> {
     | CompanyType.Legal
 
   /** Счета */
-  accounts: CollectionRef<MetaType.Account>
+  accounts: CollectionRef<'account'>
 
   /** Полное наименование */
   legalTitle?: string

src/model/ContactPerson.ts

@@ -3,9 +3,7 @@ import type { EntityRef } from './EntityRef'
 import type { HasUpdated } from './HasUpdated'
 import type { MetaType } from './MetaType'
 
-export interface ContactPerson
-  extends Entity<MetaType.ContactPerson>,
-    HasUpdated {
+export interface ContactPerson extends Entity<'contactperson'>, HasUpdated {
   /** Наименование */
   name: string
 
@@ -21,5 +19,5 @@ export interface ContactPerson
 
   position?: string
 
-  agent: EntityRef<MetaType.Counterparty>
+  agent: EntityRef<'counterparty'>
 }

src/model/Counterparty.ts

@@ -6,18 +6,18 @@ import type { MetaType } from './MetaType'
 import type { Person } from './Person'
 import type { PriceType } from './PriceType'
 
-export interface CounterpartyBase extends Company<MetaType.Counterparty> {
+export interface CounterpartyBase extends Company<'counterparty'> {
   /** Статус */
-  state: EntityRef<MetaType.State>
+  state: EntityRef<'state'>
 
   /** Группы (теги) */
   tags: string[]
 
   /** Контактные лица */
-  contactpersons: CollectionRef<MetaType.ContactPerson>
+  contactpersons: CollectionRef<'contactperson'>
 
   /** События */
-  notes: EntityRef<MetaType.Note>
+  notes: EntityRef<'note'>
 
   /** Номер дисконтной карты */
   discountCardNumber?: string

src/model/CustomerOrder.ts

@@ -1,31 +1,38 @@
-import type { EntityRef } from './EntityRef'
-import type { HasVat } from './HasVat'
-import type { MetaType } from './MetaType'
-import type { Order, OrderExpand } from './Order'
-import type { TaxSystem } from './TaxSystem'
+import type {
+  EntityRef,
+  HasVat,
+  Order,
+  OrderExpand,
+  OrderPatch,
+  TaxSystem
+} from '.'
 
-export type CustomerOrder = Order<MetaType.CustomerOrder> &
-  HasVat & {
-    taxSystem?: TaxSystem
+export type CustomerOrderFields = HasVat & {
+  taxSystem?: TaxSystem
 
-    readonly reservedSum: number
+  readonly reservedSum: number
 
-    purchaseOrders?: EntityRef<MetaType.PurchaseOrder>[]
+  purchaseOrders?: EntityRef<'purchaseorder'>[]
 
-    // TODO Проверить связи (нет в документации?)
+  // TODO Проверить связи (нет в документации?)
 
-    readonly shippedSum: number
-    demands?: EntityRef<MetaType.Demand>[]
+  readonly shippedSum: number
+  demands?: EntityRef<'demand'>[]
 
-    readonly invoicedSum: number
-    invoicesOut?: EntityRef<MetaType.InvoiceOut>[]
+  readonly invoicedSum: number
+  invoicesOut?: EntityRef<'invoiceout'>[]
 
-    readonly payedSum: number
-    payments?: EntityRef<MetaType.PaymentOut | MetaType.PaymentIn>[]
-  }
+  readonly payedSum: number
+  payments?: EntityRef<'paymentout' | 'paymentin'>[]
+}
+
+export type CustomerOrder = Order<'customerorder'> & CustomerOrderFields
 
 export type CustomerOrderExpand = Pick<
   CustomerOrder,
   'purchaseOrders' | 'demands' | 'invoicesOut' | 'payments'
 > &
-  OrderExpand<MetaType.CustomerOrder>
+  OrderExpand<'customerorder'>
+
+export type CustomerOrderPatch = OrderPatch<'customerorder'> &
+  Partial<Pick<CustomerOrderFields, 'taxSystem'>>

src/model/CustomerOrderPosition.ts

@@ -1,11 +1,21 @@
-import type { MetaType } from './MetaType'
-import type { Position } from './Position'
+import type { Position, PositionPatch } from './Position'
 
-export interface CustomerOrderPosition
-  extends Position<MetaType.CustomerOrderPosition> {
+export type CustomerOrderPositionFields = {
+  /**
+   * НДС
+   */
   vat: number
 
   shipped: number
 
+  /**
+   * Зарезервированное кол-во товара в позиции
+   */
   reserve: number
 }
+
+export type CustomerOrderPosition = Position<'customerorderposition'> &
+  CustomerOrderPositionFields
+
+export type CustomerOrderPositionPatch = PositionPatch<'customerorderposition'> &
+  Partial<Pick<CustomerOrderPositionFields, 'vat' | 'reserve' | 'shipped'>>

src/model/Demand.ts

@@ -1,3 +1,3 @@
 import type { DocumentWithPositions, HasVat, MetaType } from '.'
 
-export type Demand = DocumentWithPositions<MetaType.Demand> & HasVat
+export type Demand = DocumentWithPositions<'demand'> & HasVat

src/model/Discount.ts

@@ -1,8 +1,7 @@
 import type { Entity } from './Entity'
 import type { EntityRef } from './EntityRef'
-import type { MetaType } from './MetaType'
 
-export interface Discount extends Entity<MetaType.Discount> {
+export interface Discount extends Entity<'discount'> {
   name: string
 
   active: boolean
@@ -11,5 +10,5 @@ export interface Discount extends Entity<MetaType.Discount> {
 
   agentTags: string[]
 
-  assortment?: EntityRef<MetaType.Product>[] // TODO Проверить
+  assortment?: EntityRef<'product'>[] // TODO Проверить
 }