@six-socks-studio/sane-shopify-types - npm Package Compare versions

Comparing version 0.20.0 to 0.20.4

CHANGELOG.md

@@ -6,8 +6,51 @@ # Change Log
 
-# [0.20.0](https://github.com/good-idea/sane-shopify/compare/v0.19.12...v0.20.0) (2021-03-30)
+## 0.20.4 (2021-03-25)
 
+**Note:** Version bump only for package @sane-shopify/types
+
+
+
+
+
+## 0.20.3 (2021-03-17)
+
+**Note:** Version bump only for package @sane-shopify/types
+
+
+
+
+
+## 0.20.2 (2021-03-17)
+
+
+### Bug Fixes
+
+* **types:** fix webhooks config types ([#156](https://github.com/good-idea/sane-shopify/issues/156)) ([c48e3e5](https://github.com/good-idea/sane-shopify/commit/c48e3e54ddf5bfecb3537850b7d236c0e6d94de2))
+
+
+
+
+
+## 0.20.1 (2021-03-17)
+
+
+### Bug Fixes
+
+* **types:** fix webhooks config types ([#154](https://github.com/good-idea/sane-shopify/issues/154)) ([c71a230](https://github.com/good-idea/sane-shopify/commit/c71a23051318b15382f3d98e1c1510b7708de30d))
+
+
+
+
+
+# 0.20.0 (2021-03-17)
+
+
 ### Features
 
-- **sanity-plugin:** added media field to source data in order to get also videos ([774358d](https://github.com/good-idea/sane-shopify/commit/774358dc814c2fec3d367875b86ddec3570fe804))
+* **sanity-plugin:** added media field to source data ([#149](https://github.com/good-idea/sane-shopify/issues/149)) ([58ed53b](https://github.com/good-idea/sane-shopify/commit/58ed53b516b958755906c97a68923091916e8533))
 
+
+
+
+
 ## 0.19.12 (2021-02-25)
@@ -17,8 +60,17 @@
 
+
+
+
+
 ## 0.19.11 (2021-02-24)
 
+
 ### Bug Fixes
 
-- **sync-utils:** fix duplicate type import ([9d552d4](https://github.com/good-idea/sane-shopify/commit/9d552d40684dff4d590b3989777d1f4308084bb6))
+* **sync-utils:** fix duplicate type import ([9d552d4](https://github.com/good-idea/sane-shopify/commit/9d552d40684dff4d590b3989777d1f4308084bb6))
 
+
+
+
+
 ## 0.19.10 (2021-02-22)
@@ -28,2 +80,6 @@
 
+
+
+
+
 ## 0.19.9 (2021-02-16)
@@ -33,2 +89,6 @@
 
+
+
+
+
 ## 0.19.8 (2021-02-10)
@@ -38,26 +98,50 @@
 
+
+
+
+
 ## 0.19.7 (2021-02-06)
 
+
 ### Bug Fixes
 
-- **sync-utils:** dummy fix for version bump (7) ([541ae82](https://github.com/good-idea/sane-shopify/commit/541ae82f651ab49c7698c1b1c6bc7457f0b4e323))
+* **sync-utils:** dummy fix for version bump (7) ([541ae82](https://github.com/good-idea/sane-shopify/commit/541ae82f651ab49c7698c1b1c6bc7457f0b4e323))
 
+
+
+
+
 ## 0.19.6 (2021-02-06)
 
+
 ### Bug Fixes
 
-- **sync-utils:** dummy fix for version bump (6) ([3778ea9](https://github.com/good-idea/sane-shopify/commit/3778ea9cf4ffcabd7edf441e1b1a166a273b1558))
+* **sync-utils:** dummy fix for version bump (6) ([3778ea9](https://github.com/good-idea/sane-shopify/commit/3778ea9cf4ffcabd7edf441e1b1a166a273b1558))
 
+
+
+
+
 ## 0.19.5 (2021-02-06)
 
+
 ### Bug Fixes
 
-- **sync-utils:** dummy fix for version bump (4) ([9889d3c](https://github.com/good-idea/sane-shopify/commit/9889d3c59b2a45b22dd708c8ff97c63d3507f13e))
+* **sync-utils:** dummy fix for version bump (4) ([9889d3c](https://github.com/good-idea/sane-shopify/commit/9889d3c59b2a45b22dd708c8ff97c63d3507f13e))
 
+
+
+
+
 ## 0.19.4 (2021-02-06)
 
+
 ### Bug Fixes
 
-- **sync-utils:** dummy fix for version bump (2) ([f5e8097](https://github.com/good-idea/sane-shopify/commit/f5e80976ea287e96d49f138628755891ca0362b7))
+* **sync-utils:** dummy fix for version bump (2) ([f5e8097](https://github.com/good-idea/sane-shopify/commit/f5e80976ea287e96d49f138628755891ca0362b7))
 
+
+
+
+
 ## 0.19.3 (2021-02-05)
@@ -67,2 +151,6 @@
 
+
+
+
+
 ## 0.19.2 (2021-02-05)
@@ -72,20 +160,39 @@
 
+
+
+
+
 ## [0.19.1](https://github.com/good-idea/sane-shopify/compare/v0.19.0...v0.19.1) (2021-01-14)
 
+
 ### Bug Fixes
 
-- **types:** rename collectionKeys to collectionRefs ([384ab54](https://github.com/good-idea/sane-shopify/commit/384ab5498d02a2f59dc83789c28a0fc6f229e2f4))
+* **types:** rename collectionKeys to collectionRefs ([384ab54](https://github.com/good-idea/sane-shopify/commit/384ab5498d02a2f59dc83789c28a0fc6f229e2f4))
 
+
+
+
+
 # [0.19.0](https://github.com/good-idea/sane-shopify/compare/v0.18.2...v0.19.0) (2021-01-14)
 
+
 ### Features
 
-- **types:** improve types for webhook syncing ([1bd1261](https://github.com/good-idea/sane-shopify/commit/1bd1261794fdc946ff42cde39357787e576366c5))
+* **types:** improve types for webhook syncing ([1bd1261](https://github.com/good-idea/sane-shopify/commit/1bd1261794fdc946ff42cde39357787e576366c5))
 
+
+
+
+
 ## [0.18.1](https://github.com/good-idea/sane-shopify/compare/v0.18.0...v0.18.1) (2020-11-18)
 
+
 ### Bug Fixes
 
-- **types:** fix sanity/client type imports ([724e8b3](https://github.com/good-idea/sane-shopify/commit/724e8b3dc5733c703474436152c7fb921b96bb6a))
+* **types:** fix sanity/client type imports ([724e8b3](https://github.com/good-idea/sane-shopify/commit/724e8b3dc5733c703474436152c7fb921b96bb6a))
 
+
+
+
+
 # [0.18.0](https://github.com/good-idea/sane-shopify/compare/v0.17.6...v0.18.0) (2020-11-08)
@@ -92,0 +199,0 @@

dist/sane-shopify-types.cjs.development.js

@@ -19,2 +19,11 @@ 'use strict';
 })(exports.SyncEventType || (exports.SyncEventType = {}));
+
+(function (SyncStates) {
+  SyncStates["INIT"] = "INIT";
+  SyncStates["READY"] = "READY";
+  SyncStates["SETUP"] = "SETUP";
+  SyncStates["SYNCING"] = "SYNCING";
+  SyncStates["COMPLETE"] = "COMPLETE";
+  SyncStates["SYNC_ERROR"] = "SYNC_ERROR";
+})(exports.SyncStates || (exports.SyncStates = {}));
 //# sourceMappingURL=sane-shopify-types.cjs.development.js.map

dist/sane-shopify-types.cjs.production.min.js

@@ -1,2 +0,2 @@
-"use strict";var e;Object.defineProperty(exports,"__esModule",{value:!0}),(e=exports.SyncEventType||(exports.SyncEventType={})).Valid="VALID",e.SavedSecrets="SAVED_SECRETS",e.DocumentsFetched="DOCUMENTS_FETCHED",e.FetchComplete="FETCHED_COMPLETE",e.DocumentsSynced="DOCUMENTS_SYNCED",e.DocumentsLinked="DOCUMENTS_LINKED",e.Errored="ERRORED",e.Invalid="INVALID",e.Sync="SYNC",e.ClearedSecrets="CLEARED_SECRETS",e.Complete="COMPLETE",e.Reset="RESET";
+"use strict";var e,E;Object.defineProperty(exports,"__esModule",{value:!0}),(e=exports.SyncEventType||(exports.SyncEventType={})).Valid="VALID",e.SavedSecrets="SAVED_SECRETS",e.DocumentsFetched="DOCUMENTS_FETCHED",e.FetchComplete="FETCHED_COMPLETE",e.DocumentsSynced="DOCUMENTS_SYNCED",e.DocumentsLinked="DOCUMENTS_LINKED",e.Errored="ERRORED",e.Invalid="INVALID",e.Sync="SYNC",e.ClearedSecrets="CLEARED_SECRETS",e.Complete="COMPLETE",e.Reset="RESET",(E=exports.SyncStates||(exports.SyncStates={})).INIT="INIT",E.READY="READY",E.SETUP="SETUP",E.SYNCING="SYNCING",E.COMPLETE="COMPLETE",E.SYNC_ERROR="SYNC_ERROR";
 //# sourceMappingURL=sane-shopify-types.cjs.production.min.js.map

dist/sane-shopify-types.esm.js

@@ -18,3 +18,14 @@ var SyncEventType;
 
-export { SyncEventType };
+var SyncStates;
+
+(function (SyncStates) {
+  SyncStates["INIT"] = "INIT";
+  SyncStates["READY"] = "READY";
+  SyncStates["SETUP"] = "SETUP";
+  SyncStates["SYNCING"] = "SYNCING";
+  SyncStates["COMPLETE"] = "COMPLETE";
+  SyncStates["SYNC_ERROR"] = "SYNC_ERROR";
+})(SyncStates || (SyncStates = {}));
+
+export { SyncEventType, SyncStates };
 //# sourceMappingURL=sane-shopify-types.esm.js.map

dist/types/sanity.d.ts

@@ -8,2 +8,3 @@ import { Product, Collection, ShopifyItem, Variant, ShopifySecrets } from './shopify';
 export interface SanityClientConfig {
+    apiVersion?: string;
     projectId: string;
@@ -10,0 +11,0 @@ dataset: string;

dist/types/server.d.ts

@@ -23,5 +23,4 @@ import { SaneShopifyConfig } from './index';
 }
-export interface WebhooksConfig {
-    config: SaneShopifyConfig;
+export interface WebhooksConfig extends SaneShopifyConfig {
     onError?: (err: Error) => void;
 }

dist/types/syncState.d.ts

@@ -69,13 +69,21 @@ import { Typestate, StateMachine, StateSchema, EventObject } from 'xstate';
 } | ReadyEvent | SavedSecretsEvent | DocumentsFetchedEvent | DocumentsFetchedCompleteEvent | DocumentsSyncedEvent | DocumentsLinkedEvent | ErrorEvent;
+export declare enum SyncStates {
+    INIT = "INIT",
+    READY = "READY",
+    SETUP = "SETUP",
+    SYNCING = "SYNCING",
+    COMPLETE = "COMPLETE",
+    SYNC_ERROR = "SYNC_ERROR"
+}
 export interface SyncSchema extends StateSchema {
     context: SyncContext;
     states: {
-        init: {};
-        setup: {};
-        ready: {};
-        syncing: {};
-        complete: {};
-        syncError: {};
+        [SyncStates.INIT]: Record<string, any>;
+        [SyncStates.SETUP]: Record<string, any>;
+        [SyncStates.READY]: Record<string, any>;
+        [SyncStates.SYNCING]: Record<string, any>;
+        [SyncStates.COMPLETE]: Record<string, any>;
+        [SyncStates.SYNC_ERROR]: Record<string, any>;
     };
 }
 export declare type SyncMachineState = StateMachine<SyncContext, any, SyncEvent, Typestate<SyncContext>>['initialState'];

package.json

 {
   "name": "@six-socks-studio/sane-shopify-types",
-  "version": "0.20.0",
+  "version": "0.20.4",
   "description": "Common typescript typings for @sane-shopify projects",
@@ -43,3 +43,3 @@ "author": "Joseph Thomas <[e-mail]>",
   },
-  "gitHead": "c896fed6cbd0ae3b7512488491d6b3b17afb4fdc"
+  "gitHead": "dadf14ee1bc10e67ba5019dc8d391d7756b3e656"
 }

README.md

@@ -0,1 +1,8 @@
+# `@sane-shopify/types`
+
+<!-- toc -->
+- [Reasoning](#reasoning)
+- [Usage](#usage)
+
+<!-- tocstop -->
 This package is a Typescript typeRoot of typings of both common types throughout the @sane-shopify repo and external packages that otherwise have no types of their own.
@@ -24,3 +31,3 @@
 ```ts
-import { ShopifyClient } from '@six-socks-studio/sane-shopify-types'
+import { ShopifyClient } from '@sane-shopify/types'
 ```
@@ -27,0 +34,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

42467

increased by6.05%

Lines of code

470

increased by5.86%

Number of lines in readme file

52

increased by15.56%

Worsened metrics

Number of package files

18

decreased by-5.26%

No dependency changes