sanity-plugin-shopify-assets 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Sanity.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,106 @@
+# sanity-plugin-shopify-assets
+
+> This is a **Sanity Studio v3** plugin.
+
+Select assets from your Shopify store in the context of your Sanity Studio. This plugin allows you to serve assets from the Shopify CDN in your frontends.
+
+## Installation
+
+```
+npm install sanity-plugin-shopify-assets
+```
+
+## Usage
+
+Add it as a plugin in sanity.config.ts (or .js):
+
+```
+ import {defineConfig} from 'sanity'
+ import {shopifyAssets} from 'sanity-plugin-shopify-assets'
+
+ export const defineConfig({
+     //...
+     plugins: [
+         shopifyAssets({
+            shopifyDomain: '*.myshopify.com'
+         })
+     ]
+ })
+```
+
+Simply update the `shopifyDomain` to your store URL. You'll need to install the [Sanity Connect](https://www.sanity.io/docs/sanity-connect-for-shopify) app on your store to handle authorisation.
+
+Then you can enable the asset selector on a field:
+
+```
+import {defineType, defineField} from 'sanity'
+
+export const myDocumentSchema = defineType({
+  type: "document",
+  name: "article",
+  fields: [
+    defineField({
+      type: "shopify.asset",
+      name: "shopifyAsset",
+    }),
+  ]
+})
+```
+
+It's also possible to define the Shopify domain on the field level, which allows you to retrieve assets from different stores. Each store must be connected to your Sanity project via the Sanity Connect app. In order to do this, simply declare the `shopifyDomain` on the field:
+
+```
+defineField({
+  type: "shopify.asset",
+  name: "shopifyAsset",
+  options: {
+    shopifyDomain: '*.myshopify.com'
+  }
+}),
+```
+
+## Example of resulting object
+
+```jsonc
+{
+  "id": "gid://shopify/MediaImage/21154034647345",
+  "url": "https://cdn.shopify.com/s/files/1/0555/4906/7569/files/Green_1.jpg?v=1665668073",
+  "type": "image", // image, video, or file
+  "meta": {
+    "fileSize": 362812,
+    "alt": "",
+    "width": 3169,
+    "height": 3169,
+    "duration": 60 // video only
+  },
+  "preview": {
+    "url": "https://cdn.shopify.com/s/files/1/0555/4906/7569/files/Green_1.jpg?v=1665668073",
+    "width": 3169,
+    "height": 3169
+  },
+  "filename": "Green_1.jpg"
+}
+```
+
+## License
+
+[MIT](LICENSE) © Sanity.io <hello@sanity.io>
+
+## Develop & test
+
+This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit)
+with default configuration for build & watch scripts.
+
+See [Testing a plugin in Sanity Studio](https://github.com/sanity-io/plugin-kit#testing-a-plugin-in-sanity-studio)
+on how to run this plugin with hotreload in the studio.
+
+## License
+
+[MIT](LICENSE) © Sanity.io
+
+### Release new version
+
+Run ["CI & Release" workflow](https://github.com/sanity-io/sanity-plugin-shopify-assets/actions/workflows/main.yml).
+Make sure to select the main branch and check "Release new version".
+
+Semantic release will only release on configured branches, so it is safe to run release on any branch.

package/dist/index.d.ts

@@ -0,0 +1,73 @@
+import {ObjectSchemaType} from 'sanity'
+import {Plugin as Plugin_2} from 'sanity'
+
+export declare interface Asset extends ShopifyFile {
+  _type?: string
+  _key?: string
+  filename?: string
+}
+
+export declare interface AssetMeta {
+  alt?: string
+  duration?: number
+  fileSize?: number
+  height?: number
+  width?: number
+}
+
+export declare interface AssetPreviewImage {
+  height: number
+  url: string
+  width: number
+}
+
+export declare interface ObjectSchemaWithOptions extends ObjectSchemaType {
+  options: {
+    shopifyDomain: string
+  }
+}
+
+export declare interface PageInfo {
+  hasNextPage: boolean
+  cursor: string
+}
+
+export declare interface PluginConfig {
+  /**
+   * Your *.myshopify.com domain. Do not include https:// or any path.
+   */
+  shopifyDomain: string
+}
+
+declare type PossibleFileTypes = 'file' | 'image' | 'video'
+
+export declare interface ShopifyAPIResponse {
+  pageInfo: PageInfo
+  assets: ShopifyFile[]
+}
+
+export declare const shopifyAssets: Plugin_2<PluginConfig>
+
+export declare interface ShopifyFile {
+  meta: AssetMeta
+  preview: AssetPreviewImage
+  id: string
+  type: PossibleFileTypes
+  url: string
+}
+
+export {}
+
+declare module 'sanity' {
+  namespace Schema {
+    type ShopifyAssetTypeDef = Omit<ObjectDefinition, 'type' | 'fields'> & {
+      type: 'shopify.asset'
+      options: {
+        shopifyDomain: string
+      }
+    }
+    interface IntrinsicTypeDefinition {
+      'shopify.asset': ShopifyAssetTypeDef
+    }
+  }
+}