@takeshape/schema 8.20.2 → 8.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (20) hide show
  1. package/es/schema-util.js +4 -0
  2. package/es/validate.js +3 -6
  3. package/examples/dependencies/fabric-ecommerce.json +9716 -0
  4. package/examples/dependencies/pruned-shopify-product-schema.json +9672 -0
  5. package/examples/dependencies/shopify-store-with-widget.json +9854 -0
  6. package/examples/dependencies/stripe-starter-resolved.json +27345 -0
  7. package/examples/latest/fabric-ecommerce.json +8901 -119
  8. package/examples/latest/pruned-shopify-product-schema.json +2835 -2496
  9. package/examples/latest/rick-and-morty-ast.json +1 -1
  10. package/examples/latest/shopify-store-with-widget.json +4532 -4234
  11. package/examples/latest/stripe-starter-resolved.json +20090 -12155
  12. package/examples/source/fabric-ecommerce.json +0 -894
  13. package/examples/source/pruned-shopify-product-schema.json +1 -9333
  14. package/examples/source/shopify-store-with-widget.json +0 -8953
  15. package/examples/source/stripe-starter-resolved.json +0 -19409
  16. package/lib/schema-util.d.ts.map +1 -1
  17. package/lib/schema-util.js +4 -0
  18. package/lib/validate.d.ts.map +1 -1
  19. package/lib/validate.js +3 -6
  20. package/package.json +4 -4
package/examples/source/fabric-ecommerce.json CHANGED
@@ -598,900 +598,6 @@
598
598
  }
599
599
  }
600
600
  },
601
- "Shopify_Product": {
602
- "name": "Shopify_Product",
603
- "title": "Shopify_Product",
604
- "id": "Shopify_Product",
605
- "description": "The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productvariant)\nto create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/media).\nProducts can be organized by grouping them into a [Collection](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/collection).",
606
- "schema": {
607
- "type": "object",
608
- "properties": {
609
- "character": {
610
- "$ref": "#/shapes/Character/schema",
611
- "type": "object",
612
- "title": "Character",
613
- "@resolver": {
614
- "name": "rest:post",
615
- "service": "rick",
616
- "options": {
617
- "path": "/character/1"
618
- }
619
- }
620
- },
621
- "attributes": {
622
- "items": {
623
- "$ref": "#/shapes/ProductAttributes/schema"
624
- },
625
- "type": "array",
626
- "@resolver": {
627
- "resultsMapping": [
628
- [
629
- "expressionEval",
630
- {
631
- "expression": "map(compose(compose(zipObject(['description', 'id', 'name', 'namespace', 'type', 'value']), map(get('[1]'))), sortBy('[0]'), toPairs, get('node')), get('metafields.edges', steps[0]))"
632
- }
633
- ]
634
- ],
635
- "name": "graphql:query",
636
- "service": "michaels-store-takeshape",
637
- "options": {
638
- "fieldName": "product",
639
- "selectionSet": "{ metafields(first: 10) { edges { node { id namespace ownerType value description key } } } }"
640
- },
641
- "argsMapping": {
642
- "id": [
643
- [
644
- "get",
645
- {
646
- "path": "source.id"
647
- }
648
- ]
649
- ]
650
- }
651
- }
652
- },
653
- "availablePublicationCount": {
654
- "type": "integer",
655
- "@mapping": "michaels-store-takeshape:Product.availablePublicationCount",
656
- "description": "The number of publications a resource is published to without feedback errors."
657
- },
658
- "bodyHtml": {
659
- "type": "string",
660
- "@mapping": "michaels-store-takeshape:Product.bodyHtml",
661
- "@deprecationReason": "Use `descriptionHtml` instead",
662
- "description": "The description of the product, complete with HTML formatting."
663
- },
664
- "collections": {
665
- "@ref": "michaels-store-takeshape:CollectionConnection",
666
- "@mapping": "michaels-store-takeshape:Product.collections",
667
- "@args": {
668
- "type": "object",
669
- "properties": {
670
- "first": {
671
- "type": "integer",
672
- "description": "Returns up to the first `n` elements from the list."
673
- },
674
- "after": {
675
- "type": "string",
676
- "description": "Returns the elements that come after the specified cursor."
677
- },
678
- "last": {
679
- "type": "integer",
680
- "description": "Returns up to the last `n` elements from the list."
681
- },
682
- "before": {
683
- "type": "string",
684
- "description": "Returns the elements that come before the specified cursor."
685
- },
686
- "reverse": {
687
- "type": "boolean",
688
- "description": "Reverse the order of the underlying list.",
689
- "default": false
690
- },
691
- "sortKey": {
692
- "description": "Sort the underlying list by the given key.",
693
- "enum": ["TITLE", "UPDATED_AT", "ID", "RELEVANCE"],
694
- "default": "ID"
695
- },
696
- "query": {
697
- "type": "string",
698
- "description": "Supported filter parameters:\n - `collection_type`\n - `publishable_status`\n - `published_status`\n - `title`\n - `updated_at`\n\nSee the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax)\nfor more information about using filters."
699
- }
700
- }
701
- },
702
- "description": "A list of the collections that include the product."
703
- },
704
- "createdAt": {
705
- "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was created.",
706
- "@tag": "DateTime",
707
- "@mapping": "michaels-store-takeshape:Product.createdAt"
708
- },
709
- "defaultCursor": {
710
- "type": "string",
711
- "@mapping": "michaels-store-takeshape:Product.defaultCursor",
712
- "description": "A default cursor that returns the single next record, sorted ascending by ID."
713
- },
714
- "description": {
715
- "type": "string",
716
- "@mapping": "michaels-store-takeshape:Product.description",
717
- "@args": {
718
- "type": "object",
719
- "properties": {
720
- "truncateAt": {
721
- "type": "integer",
722
- "description": "Truncates string after the given length."
723
- }
724
- }
725
- },
726
- "description": "A stripped description of the product, single line with HTML tags removed."
727
- },
728
- "descriptionHtml": {
729
- "description": "The description of the product, complete with HTML formatting.",
730
- "@tag": "HTML",
731
- "@mapping": "michaels-store-takeshape:Product.descriptionHtml"
732
- },
733
- "descriptionPlainSummary": {
734
- "type": "string",
735
- "@mapping": "michaels-store-takeshape:Product.descriptionPlainSummary",
736
- "@deprecationReason": "Use `description` instead",
737
- "description": "Stripped description of the product, single line with HTML tags removed.\nTruncated to 60 characters."
738
- },
739
- "featuredImage": {
740
- "@ref": "michaels-store-takeshape:Image",
741
- "@mapping": "michaels-store-takeshape:Product.featuredImage",
742
- "description": "The featured image for the product."
743
- },
744
- "featuredMedia": {
745
- "@ref": "michaels-store-takeshape:Media",
746
- "@mapping": "michaels-store-takeshape:Product.featuredMedia",
747
- "description": "The featured media for the product."
748
- },
749
- "feedback": {
750
- "@ref": "michaels-store-takeshape:ResourceFeedback",
751
- "@mapping": "michaels-store-takeshape:Product.feedback",
752
- "description": "Information about the product that's provided through resource feedback."
753
- },
754
- "giftCardTemplateSuffix": {
755
- "type": "string",
756
- "@mapping": "michaels-store-takeshape:Product.giftCardTemplateSuffix",
757
- "description": "The theme template used when viewing the gift card in a store."
758
- },
759
- "handle": {
760
- "type": "string",
761
- "@mapping": "michaels-store-takeshape:Product.handle",
762
- "description": "A unique human-friendly string of the product's title."
763
- },
764
- "hasOnlyDefaultVariant": {
765
- "type": "boolean",
766
- "@mapping": "michaels-store-takeshape:Product.hasOnlyDefaultVariant",
767
- "description": "Whether the product has only a single variant with the default option and value."
768
- },
769
- "hasOutOfStockVariants": {
770
- "type": "boolean",
771
- "@mapping": "michaels-store-takeshape:Product.hasOutOfStockVariants",
772
- "description": "Whether the product has out of stock variants."
773
- },
774
- "id": {
775
- "type": "string",
776
- "@tag": "id",
777
- "@mapping": "michaels-store-takeshape:Product.id",
778
- "description": "A globally-unique identifier."
779
- },
780
- "images": {
781
- "@ref": "michaels-store-takeshape:ImageConnection",
782
- "@mapping": "michaels-store-takeshape:Product.images",
783
- "@args": {
784
- "type": "object",
785
- "properties": {
786
- "first": {
787
- "type": "integer",
788
- "description": "Returns up to the first `n` elements from the list."
789
- },
790
- "after": {
791
- "type": "string",
792
- "description": "Returns the elements that come after the specified cursor."
793
- },
794
- "last": {
795
- "type": "integer",
796
- "description": "Returns up to the last `n` elements from the list."
797
- },
798
- "before": {
799
- "type": "string",
800
- "description": "Returns the elements that come before the specified cursor."
801
- },
802
- "reverse": {
803
- "type": "boolean",
804
- "description": "Reverse the order of the underlying list.",
805
- "default": false
806
- },
807
- "sortKey": {
808
- "description": "Sort the underlying list by the given key.",
809
- "enum": ["CREATED_AT", "POSITION", "ID", "RELEVANCE"],
810
- "default": "POSITION"
811
- },
812
- "maxWidth": {
813
- "type": "integer",
814
- "description": "Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead."
815
- },
816
- "maxHeight": {
817
- "type": "integer",
818
- "description": "Image height in pixels between 1 and 2048. This argument is deprecated: Use\n`maxHeight` on `Image.transformedSrc` instead."
819
- },
820
- "crop": {
821
- "description": "Crops the image according to the specified region. This argument is\ndeprecated: Use `crop` on `Image.transformedSrc` instead.",
822
- "enum": ["CENTER", "TOP", "BOTTOM", "LEFT", "RIGHT"]
823
- },
824
- "scale": {
825
- "type": "integer",
826
- "description": "Image size multiplier for high-resolution retina displays. Must be between 1\nand 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead.",
827
- "default": "1"
828
- }
829
- }
830
- },
831
- "description": "The images associated with the product."
832
- },
833
- "inCollection": {
834
- "type": "boolean",
835
- "@mapping": "michaels-store-takeshape:Product.inCollection",
836
- "@args": {
837
- "type": "object",
838
- "properties": {
839
- "id": {
840
- "type": "string",
841
- "@tag": "id",
842
- "description": "The ID of the collection to check."
843
- }
844
- },
845
- "required": ["id"]
846
- },
847
- "description": "Whether the product is in a given collection."
848
- },
849
- "isGiftCard": {
850
- "type": "boolean",
851
- "@mapping": "michaels-store-takeshape:Product.isGiftCard",
852
- "description": "Whether the product is a gift card."
853
- },
854
- "legacyResourceId": {
855
- "description": "The ID of the corresponding resource in the REST Admin API.",
856
- "@tag": "UnsignedInt64",
857
- "@mapping": "michaels-store-takeshape:Product.legacyResourceId"
858
- },
859
- "media": {
860
- "@ref": "michaels-store-takeshape:MediaConnection",
861
- "@mapping": "michaels-store-takeshape:Product.media",
862
- "@args": {
863
- "type": "object",
864
- "properties": {
865
- "first": {
866
- "type": "integer",
867
- "description": "Returns up to the first `n` elements from the list."
868
- },
869
- "after": {
870
- "type": "string",
871
- "description": "Returns the elements that come after the specified cursor."
872
- },
873
- "last": {
874
- "type": "integer",
875
- "description": "Returns up to the last `n` elements from the list."
876
- },
877
- "before": {
878
- "type": "string",
879
- "description": "Returns the elements that come before the specified cursor."
880
- },
881
- "reverse": {
882
- "type": "boolean",
883
- "description": "Reverse the order of the underlying list.",
884
- "default": false
885
- },
886
- "sortKey": {
887
- "description": "Sort the underlying list by the given key.",
888
- "enum": ["POSITION", "ID", "RELEVANCE"],
889
- "default": "POSITION"
890
- }
891
- }
892
- },
893
- "description": "The media associated with the product. This can include images, 3D models, or videos."
894
- },
895
- "mediaCount": {
896
- "type": "integer",
897
- "@mapping": "michaels-store-takeshape:Product.mediaCount",
898
- "description": "Total count of media belonging to a product."
899
- },
900
- "metafield": {
901
- "@ref": "michaels-store-takeshape:Metafield",
902
- "@mapping": "michaels-store-takeshape:Product.metafield",
903
- "@args": {
904
- "type": "object",
905
- "properties": {
906
- "namespace": {
907
- "type": "string",
908
- "description": "The namespace for the metafield."
909
- },
910
- "key": {
911
- "type": "string",
912
- "description": "The key for the metafield."
913
- }
914
- },
915
- "required": ["namespace", "key"]
916
- },
917
- "description": "Returns a metafield by namespace and key that belongs to the resource."
918
- },
919
- "metafields": {
920
- "@ref": "michaels-store-takeshape:MetafieldConnection",
921
- "@mapping": "michaels-store-takeshape:Product.metafields",
922
- "@args": {
923
- "type": "object",
924
- "properties": {
925
- "namespace": {
926
- "type": "string",
927
- "description": "The metafield namespace to filter by."
928
- },
929
- "first": {
930
- "type": "integer",
931
- "description": "Returns up to the first `n` elements from the list."
932
- },
933
- "after": {
934
- "type": "string",
935
- "description": "Returns the elements that come after the specified cursor."
936
- },
937
- "last": {
938
- "type": "integer",
939
- "description": "Returns up to the last `n` elements from the list."
940
- },
941
- "before": {
942
- "type": "string",
943
- "description": "Returns the elements that come before the specified cursor."
944
- },
945
- "reverse": {
946
- "type": "boolean",
947
- "description": "Reverse the order of the underlying list.",
948
- "default": false
949
- }
950
- }
951
- },
952
- "description": "List of metafields that belong to the resource."
953
- },
954
- "onlineStorePreviewUrl": {
955
- "description": "The online store preview URL.",
956
- "@tag": "URL",
957
- "@mapping": "michaels-store-takeshape:Product.onlineStorePreviewUrl"
958
- },
959
- "onlineStoreUrl": {
960
- "description": "The online store URL for the product.\nA value of `null` indicates that the product is not published to the Online Store sales channel.",
961
- "@tag": "URL",
962
- "@mapping": "michaels-store-takeshape:Product.onlineStoreUrl"
963
- },
964
- "options": {
965
- "type": "array",
966
- "items": {
967
- "@ref": "michaels-store-takeshape:ProductOption"
968
- },
969
- "@mapping": "michaels-store-takeshape:Product.options",
970
- "@args": {
971
- "type": "object",
972
- "properties": {
973
- "first": {
974
- "type": "integer",
975
- "description": "Truncate the array result to this size."
976
- }
977
- }
978
- },
979
- "description": "A list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions."
980
- },
981
- "priceRange": {
982
- "@ref": "michaels-store-takeshape:ProductPriceRange",
983
- "@mapping": "michaels-store-takeshape:Product.priceRange",
984
- "@deprecationReason": "Deprecated in API version 2020-10. Use `priceRangeV2` instead.",
985
- "description": "The price range of the product."
986
- },
987
- "priceRangeV2": {
988
- "@ref": "michaels-store-takeshape:ProductPriceRangeV2",
989
- "@mapping": "michaels-store-takeshape:Product.priceRangeV2",
990
- "description": "The price range of the product with prices formatted as decimals."
991
- },
992
- "privateMetafield": {
993
- "@ref": "michaels-store-takeshape:PrivateMetafield",
994
- "@mapping": "michaels-store-takeshape:Product.privateMetafield",
995
- "@args": {
996
- "type": "object",
997
- "properties": {
998
- "namespace": {
999
- "type": "string",
1000
- "description": "The namespace for the private metafield."
1001
- },
1002
- "key": {
1003
- "type": "string",
1004
- "description": "The key for the private metafield."
1005
- }
1006
- },
1007
- "required": ["namespace", "key"]
1008
- },
1009
- "description": "Returns a private metafield by namespace and key that belongs to the resource."
1010
- },
1011
- "privateMetafields": {
1012
- "@ref": "michaels-store-takeshape:PrivateMetafieldConnection",
1013
- "@mapping": "michaels-store-takeshape:Product.privateMetafields",
1014
- "@args": {
1015
- "type": "object",
1016
- "properties": {
1017
- "namespace": {
1018
- "type": "string",
1019
- "description": "Filter the private metafields by namespace."
1020
- },
1021
- "first": {
1022
- "type": "integer",
1023
- "description": "Returns up to the first `n` elements from the list."
1024
- },
1025
- "after": {
1026
- "type": "string",
1027
- "description": "Returns the elements that come after the specified cursor."
1028
- },
1029
- "last": {
1030
- "type": "integer",
1031
- "description": "Returns up to the last `n` elements from the list."
1032
- },
1033
- "before": {
1034
- "type": "string",
1035
- "description": "Returns the elements that come before the specified cursor."
1036
- },
1037
- "reverse": {
1038
- "type": "boolean",
1039
- "description": "Reverse the order of the underlying list.",
1040
- "default": false
1041
- }
1042
- }
1043
- },
1044
- "description": "List of private metafields that belong to the resource."
1045
- },
1046
- "productPublications": {
1047
- "@ref": "michaels-store-takeshape:ProductPublicationConnection",
1048
- "@mapping": "michaels-store-takeshape:Product.productPublications",
1049
- "@deprecationReason": "Use `resourcePublications` instead",
1050
- "@args": {
1051
- "type": "object",
1052
- "properties": {
1053
- "first": {
1054
- "type": "integer",
1055
- "description": "Returns up to the first `n` elements from the list."
1056
- },
1057
- "after": {
1058
- "type": "string",
1059
- "description": "Returns the elements that come after the specified cursor."
1060
- },
1061
- "last": {
1062
- "type": "integer",
1063
- "description": "Returns up to the last `n` elements from the list."
1064
- },
1065
- "before": {
1066
- "type": "string",
1067
- "description": "Returns the elements that come before the specified cursor."
1068
- },
1069
- "reverse": {
1070
- "type": "boolean",
1071
- "description": "Reverse the order of the underlying list.",
1072
- "default": false
1073
- }
1074
- }
1075
- },
1076
- "description": "A list of the channels where the product is published."
1077
- },
1078
- "productType": {
1079
- "type": "string",
1080
- "@mapping": "michaels-store-takeshape:Product.productType",
1081
- "description": "The product type specified by the merchant."
1082
- },
1083
- "publicationCount": {
1084
- "type": "integer",
1085
- "@mapping": "michaels-store-takeshape:Product.publicationCount",
1086
- "@args": {
1087
- "type": "object",
1088
- "properties": {
1089
- "onlyPublished": {
1090
- "type": "boolean",
1091
- "description": "Include only the resource's publications that are published. If false, then\nreturn all the resource's publications including future publications.",
1092
- "default": true
1093
- }
1094
- }
1095
- },
1096
- "description": "The number of publications a resource is published on."
1097
- },
1098
- "publications": {
1099
- "@ref": "michaels-store-takeshape:ProductPublicationConnection",
1100
- "@mapping": "michaels-store-takeshape:Product.publications",
1101
- "@deprecationReason": "Use `resourcePublications` instead",
1102
- "@args": {
1103
- "type": "object",
1104
- "properties": {
1105
- "onlyPublished": {
1106
- "type": "boolean",
1107
- "description": "Return only the publications that are published. If false, then return all publications.",
1108
- "default": true
1109
- },
1110
- "first": {
1111
- "type": "integer",
1112
- "description": "Returns up to the first `n` elements from the list."
1113
- },
1114
- "after": {
1115
- "type": "string",
1116
- "description": "Returns the elements that come after the specified cursor."
1117
- },
1118
- "last": {
1119
- "type": "integer",
1120
- "description": "Returns up to the last `n` elements from the list."
1121
- },
1122
- "before": {
1123
- "type": "string",
1124
- "description": "Returns the elements that come before the specified cursor."
1125
- },
1126
- "reverse": {
1127
- "type": "boolean",
1128
- "description": "Reverse the order of the underlying list.",
1129
- "default": false
1130
- }
1131
- }
1132
- },
1133
- "description": "A list of the channels where the product is published."
1134
- },
1135
- "publishedAt": {
1136
- "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601))\nwhen the product was published to the Online Store.",
1137
- "@tag": "DateTime",
1138
- "@mapping": "michaels-store-takeshape:Product.publishedAt"
1139
- },
1140
- "publishedOnChannel": {
1141
- "type": "boolean",
1142
- "@mapping": "michaels-store-takeshape:Product.publishedOnChannel",
1143
- "@deprecationReason": "Use `publishedOnPublication` instead",
1144
- "@args": {
1145
- "type": "object",
1146
- "properties": {
1147
- "channelId": {
1148
- "type": "string",
1149
- "@tag": "id",
1150
- "description": "The ID of the channel to check."
1151
- }
1152
- },
1153
- "required": ["channelId"]
1154
- },
1155
- "description": "Check to see whether the resource is published to a given channel."
1156
- },
1157
- "publishedOnCurrentChannel": {
1158
- "type": "boolean",
1159
- "@mapping": "michaels-store-takeshape:Product.publishedOnCurrentChannel",
1160
- "@deprecationReason": "Use `publishedOnCurrentPublication` instead",
1161
- "description": "Check to see whether the resource is published to the calling app's channel."
1162
- },
1163
- "publishedOnCurrentPublication": {
1164
- "type": "boolean",
1165
- "@mapping": "michaels-store-takeshape:Product.publishedOnCurrentPublication",
1166
- "description": "Check to see whether the resource is published to the calling app's publication."
1167
- },
1168
- "publishedOnPublication": {
1169
- "type": "boolean",
1170
- "@mapping": "michaels-store-takeshape:Product.publishedOnPublication",
1171
- "@args": {
1172
- "type": "object",
1173
- "properties": {
1174
- "publicationId": {
1175
- "type": "string",
1176
- "@tag": "id",
1177
- "description": "The ID of the publication to check."
1178
- }
1179
- },
1180
- "required": ["publicationId"]
1181
- },
1182
- "description": "Check to see whether the resource is published to a given publication."
1183
- },
1184
- "resourcePublications": {
1185
- "@ref": "michaels-store-takeshape:ResourcePublicationConnection",
1186
- "@mapping": "michaels-store-takeshape:Product.resourcePublications",
1187
- "@args": {
1188
- "type": "object",
1189
- "properties": {
1190
- "onlyPublished": {
1191
- "type": "boolean",
1192
- "description": "Whether to return only the resources that are currently published. If false,\nthen also returns the resources that are scheduled to be published.",
1193
- "default": true
1194
- },
1195
- "first": {
1196
- "type": "integer",
1197
- "description": "Returns up to the first `n` elements from the list."
1198
- },
1199
- "after": {
1200
- "type": "string",
1201
- "description": "Returns the elements that come after the specified cursor."
1202
- },
1203
- "last": {
1204
- "type": "integer",
1205
- "description": "Returns up to the last `n` elements from the list."
1206
- },
1207
- "before": {
1208
- "type": "string",
1209
- "description": "Returns the elements that come before the specified cursor."
1210
- },
1211
- "reverse": {
1212
- "type": "boolean",
1213
- "description": "Reverse the order of the underlying list.",
1214
- "default": false
1215
- }
1216
- }
1217
- },
1218
- "description": "The list of resources that are published to a publication."
1219
- },
1220
- "resourcePublicationsV2": {
1221
- "@ref": "michaels-store-takeshape:ResourcePublicationV2Connection",
1222
- "@mapping": "michaels-store-takeshape:Product.resourcePublicationsV2",
1223
- "@args": {
1224
- "type": "object",
1225
- "properties": {
1226
- "onlyPublished": {
1227
- "type": "boolean",
1228
- "description": "Whether to return only the resources that are currently published. If false,\nthen also returns the resources that are scheduled or staged to be published.",
1229
- "default": true
1230
- },
1231
- "first": {
1232
- "type": "integer",
1233
- "description": "Returns up to the first `n` elements from the list."
1234
- },
1235
- "after": {
1236
- "type": "string",
1237
- "description": "Returns the elements that come after the specified cursor."
1238
- },
1239
- "last": {
1240
- "type": "integer",
1241
- "description": "Returns up to the last `n` elements from the list."
1242
- },
1243
- "before": {
1244
- "type": "string",
1245
- "description": "Returns the elements that come before the specified cursor."
1246
- },
1247
- "reverse": {
1248
- "type": "boolean",
1249
- "description": "Reverse the order of the underlying list.",
1250
- "default": false
1251
- }
1252
- }
1253
- },
1254
- "description": "The list of resources that are either published or staged to be published to a publication."
1255
- },
1256
- "seo": {
1257
- "@ref": "michaels-store-takeshape:SEO",
1258
- "@mapping": "michaels-store-takeshape:Product.seo",
1259
- "description": "SEO information of the product."
1260
- },
1261
- "status": {
1262
- "description": "The product status. This controls visibility across all channels.",
1263
- "enum": ["ACTIVE", "ARCHIVED", "DRAFT"],
1264
- "@mapping": "michaels-store-takeshape:Product.status"
1265
- },
1266
- "storefrontId": {
1267
- "description": "The storefront ID of the product.",
1268
- "@tag": "StorefrontID",
1269
- "@mapping": "michaels-store-takeshape:Product.storefrontId"
1270
- },
1271
- "tags": {
1272
- "type": "array",
1273
- "items": {
1274
- "type": "string"
1275
- },
1276
- "@mapping": "michaels-store-takeshape:Product.tags",
1277
- "description": "A comma separated list of tags associated with the product. Updating `tags` overwrites\nany existing tags that were previously added to the product. To add new tags without overwriting\nexisting tags, use the [tagsAdd](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/tagsadd)\nmutation."
1278
- },
1279
- "templateSuffix": {
1280
- "type": "string",
1281
- "@mapping": "michaels-store-takeshape:Product.templateSuffix",
1282
- "description": "The theme template used when viewing the product in a store."
1283
- },
1284
- "title": {
1285
- "type": "string",
1286
- "@mapping": "michaels-store-takeshape:Product.title",
1287
- "description": "The title of the product."
1288
- },
1289
- "totalInventory": {
1290
- "type": "integer",
1291
- "@mapping": "michaels-store-takeshape:Product.totalInventory",
1292
- "description": "The quantity of inventory in stock."
1293
- },
1294
- "totalVariants": {
1295
- "type": "integer",
1296
- "@mapping": "michaels-store-takeshape:Product.totalVariants",
1297
- "description": "The number of variants that are associated with the product."
1298
- },
1299
- "tracksInventory": {
1300
- "type": "boolean",
1301
- "@mapping": "michaels-store-takeshape:Product.tracksInventory",
1302
- "description": "Whether inventory tracking has been enabled for the product."
1303
- },
1304
- "translations": {
1305
- "type": "array",
1306
- "items": {
1307
- "@ref": "michaels-store-takeshape:PublishedTranslation"
1308
- },
1309
- "@mapping": "michaels-store-takeshape:Product.translations",
1310
- "@args": {
1311
- "type": "object",
1312
- "properties": {
1313
- "locale": {
1314
- "type": "string",
1315
- "description": "Filters translations locale."
1316
- }
1317
- },
1318
- "required": ["locale"]
1319
- },
1320
- "description": "The translations associated with the resource."
1321
- },
1322
- "unpublishedChannels": {
1323
- "@ref": "michaels-store-takeshape:ChannelConnection",
1324
- "@mapping": "michaels-store-takeshape:Product.unpublishedChannels",
1325
- "@deprecationReason": "Use `unpublishedPublications` instead",
1326
- "@args": {
1327
- "type": "object",
1328
- "properties": {
1329
- "first": {
1330
- "type": "integer",
1331
- "description": "Returns up to the first `n` elements from the list."
1332
- },
1333
- "after": {
1334
- "type": "string",
1335
- "description": "Returns the elements that come after the specified cursor."
1336
- },
1337
- "last": {
1338
- "type": "integer",
1339
- "description": "Returns up to the last `n` elements from the list."
1340
- },
1341
- "before": {
1342
- "type": "string",
1343
- "description": "Returns the elements that come before the specified cursor."
1344
- },
1345
- "reverse": {
1346
- "type": "boolean",
1347
- "description": "Reverse the order of the underlying list.",
1348
- "default": false
1349
- }
1350
- }
1351
- },
1352
- "description": "The list of channels that the resource is not published to."
1353
- },
1354
- "unpublishedPublications": {
1355
- "@ref": "michaels-store-takeshape:PublicationConnection",
1356
- "@mapping": "michaels-store-takeshape:Product.unpublishedPublications",
1357
- "@args": {
1358
- "type": "object",
1359
- "properties": {
1360
- "first": {
1361
- "type": "integer",
1362
- "description": "Returns up to the first `n` elements from the list."
1363
- },
1364
- "after": {
1365
- "type": "string",
1366
- "description": "Returns the elements that come after the specified cursor."
1367
- },
1368
- "last": {
1369
- "type": "integer",
1370
- "description": "Returns up to the last `n` elements from the list."
1371
- },
1372
- "before": {
1373
- "type": "string",
1374
- "description": "Returns the elements that come before the specified cursor."
1375
- },
1376
- "reverse": {
1377
- "type": "boolean",
1378
- "description": "Reverse the order of the underlying list.",
1379
- "default": false
1380
- }
1381
- }
1382
- },
1383
- "description": "The list of publications that the resource is not published to."
1384
- },
1385
- "updatedAt": {
1386
- "description": "The date and time when the product was last modified.\nA product's `updatedAt` value can change for different reasons. For example, if an order\nis placed for a product that has inventory tracking set up, then the inventory adjustment\nis counted as an update.",
1387
- "@tag": "DateTime",
1388
- "@mapping": "michaels-store-takeshape:Product.updatedAt"
1389
- },
1390
- "variants": {
1391
- "@ref": "michaels-store-takeshape:ProductVariantConnection",
1392
- "@mapping": "michaels-store-takeshape:Product.variants",
1393
- "@args": {
1394
- "type": "object",
1395
- "properties": {
1396
- "first": {
1397
- "type": "integer",
1398
- "description": "Returns up to the first `n` elements from the list."
1399
- },
1400
- "after": {
1401
- "type": "string",
1402
- "description": "Returns the elements that come after the specified cursor."
1403
- },
1404
- "last": {
1405
- "type": "integer",
1406
- "description": "Returns up to the last `n` elements from the list."
1407
- },
1408
- "before": {
1409
- "type": "string",
1410
- "description": "Returns the elements that come before the specified cursor."
1411
- },
1412
- "reverse": {
1413
- "type": "boolean",
1414
- "description": "Reverse the order of the underlying list.",
1415
- "default": false
1416
- },
1417
- "sortKey": {
1418
- "description": "Sort the underlying list by the given key.",
1419
- "enum": [
1420
- "TITLE",
1421
- "NAME",
1422
- "SKU",
1423
- "INVENTORY_QUANTITY",
1424
- "INVENTORY_MANAGEMENT",
1425
- "INVENTORY_LEVELS_AVAILABLE",
1426
- "INVENTORY_POLICY",
1427
- "FULL_TITLE",
1428
- "POPULAR",
1429
- "POSITION",
1430
- "ID",
1431
- "RELEVANCE"
1432
- ],
1433
- "default": "POSITION"
1434
- }
1435
- }
1436
- },
1437
- "description": "A list of variants associated with the product."
1438
- },
1439
- "vendor": {
1440
- "type": "string",
1441
- "@mapping": "michaels-store-takeshape:Product.vendor",
1442
- "description": "The name of the product's vendor."
1443
- }
1444
- },
1445
- "required": [
1446
- "availablePublicationCount",
1447
- "collections",
1448
- "createdAt",
1449
- "defaultCursor",
1450
- "description",
1451
- "descriptionHtml",
1452
- "descriptionPlainSummary",
1453
- "handle",
1454
- "hasOnlyDefaultVariant",
1455
- "hasOutOfStockVariants",
1456
- "id",
1457
- "images",
1458
- "inCollection",
1459
- "isGiftCard",
1460
- "legacyResourceId",
1461
- "media",
1462
- "mediaCount",
1463
- "metafields",
1464
- "options",
1465
- "priceRange",
1466
- "priceRangeV2",
1467
- "privateMetafields",
1468
- "productPublications",
1469
- "productType",
1470
- "publicationCount",
1471
- "publications",
1472
- "publishedOnChannel",
1473
- "publishedOnCurrentChannel",
1474
- "publishedOnCurrentPublication",
1475
- "publishedOnPublication",
1476
- "resourcePublications",
1477
- "resourcePublicationsV2",
1478
- "seo",
1479
- "status",
1480
- "storefrontId",
1481
- "tags",
1482
- "title",
1483
- "totalInventory",
1484
- "totalVariants",
1485
- "tracksInventory",
1486
- "translations",
1487
- "unpublishedChannels",
1488
- "unpublishedPublications",
1489
- "updatedAt",
1490
- "variants",
1491
- "vendor"
1492
- ]
1493
- }
1494
- },
1495
601
  "Product": {
1496
602
  "name": "Product",
1497
603
  "id": "r_P4Zu5wr",