@shopify/cli-kit 3.38.0 → 3.40.0

package/assets/cli-ruby/features/support/assertions.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "minitest/spec"
+require "minitest/assertions"
+
+class MinitestWorld
+  include Minitest::Assertions
+  attr_accessor :assertions
+
+  def initialize
+    self.assertions = 0
+  end
+end
+
+World do
+  MinitestWorld.new
+end

package/assets/cli-ruby/features/support/cli.rb

@@ -0,0 +1,7 @@
+module CLI
+  def self.version
+    version_file_path = File.expand_path("../../lib/shopify_cli/version.rb", __dir__)
+    version_file_content = File.read(version_file_path)
+    version_file_content.match(/VERSION\s+=\s+"(?<version>[0-9]+\.[0-9]+\.[0-9]+)"/)[:version].chomp
+  end
+end

package/assets/cli-ruby/features/support/process.rb

@@ -0,0 +1,27 @@
+require "open3"
+require_relative "../../utilities/utilities"
+
+module Process
+  class ProcessError < StandardError
+    attr_reader :exit_status, :stderr
+    def initialize(exit_status:, stderr:)
+      @exit_status = exit_status
+      @stderr = stderr
+      super
+    end
+
+    def to_s
+      stderr
+    end
+  end
+
+  def self.run(*args, cwd: nil)
+    cwd ||= Dir.pwd
+    _, err, stat = Open3.capture3(*args, chdir: cwd)
+    raise ProcessError.new(exit_status: stat.exitstatus, stderr: err) unless stat.success?
+  end
+
+  def self.shopify_executable_path
+    File.expand_path("../../bin/shopify", __dir__)
+  end
+end

package/assets/cli-ruby/features/support/requires.rb

@@ -0,0 +1,3 @@
+require_relative "../../utilities/utilities"
+require "byebug"
+require "fileutils"

package/assets/cli-ruby/lib/docgen/class_template.md.erb

@@ -0,0 +1,81 @@
+<%= comment %>
+<% if constants.any? -%>
+- [Constants](#constants)
+<%- end -%>
+<%- if attributes.any? -%>
+- [Attributes](#attributes)
+<%- end -%>
+<%- if class_methods.any? -%>
+- [Class Methods](#class-methods)
+<%- class_methods.each do |method| -%>
+  - [<%= method.title %>](#<%= method.title.gsub("?", "") %>)
+<%- end -%>
+<%- end -%>
+<%- if instance_methods.any? -%>
+- [Instance Methods](#instance-methods)
+<%- instance_methods.each do |method| -%>
+  - [<%= method.title %>](#<%= method.title.gsub("?", "") %>)
+<%- end -%>
+<%- end -%>
+<%- if included.any? -%>
+- [Includes](#includes)
+<%- end -%>
+<%- if extended.any? -%>
+- [Extends](#extends)
+<%- end -%>
+<%- if constants.any? %>
+## Constants
+<%- constants.each do |const| -%>
+- `<%= const.title %>` <%= const.comment %>
+<%- end -%>
+<%- end -%>
+<%- if attributes.any? %>
+## Attributes
+<%- attributes.each do |attr| -%>
+- `<%= attr.title %>` <%= attr.comment %>
+<%- end -%>
+<%- end -%>
+<%- if class_methods.any? %>
+## Class Methods
+<% class_methods.each do |method| %>
+### <%= method.title %>
+`<%= method.signature %>`
+<%= method.comment %>
+<details><summary>see source</summary><p>
+
+```ruby
+<%= method.source_code %>
+```
+</p></details>
+
+---
+<%- end -%>
+<%- end -%>
+<%- if instance_methods.any? %>
+## Instance Methods
+<% instance_methods.each do |method| %>
+### <%= method.title %>
+`<%= method.signature %>`
+<%= method.comment %>
+<details><summary>see source</summary><p>
+
+```ruby
+<%= method.source_code %>
+```
+</p></details>
+
+---
+<%- end -%>
+<%- end -%>
+<%- if included.any? %>
+## Includes
+<% included.each do |incld| %>
+- <%= incld.title %>
+<%- end -%>
+<%- end -%>
+<%- if extended.any? %>
+## Extends
+<% extended.each do |incld| %>
+- <%= incld.title %>
+<%- end -%>
+<%- end -%>

package/assets/cli-ruby/lib/docgen/index_template.md.erb

@@ -0,0 +1,5 @@
+The Shopify CLI has a set of core APIs that simplify the process of extending its functionality.
+
+<%- classes.each do |method| -%>
+- [<%= method.title %>](https://github.com/Shopify/shopify-cli/wiki/<%= method.filename %>)
+<%- end -%>

package/assets/cli-ruby/lib/docgen/markdown.rb

@@ -0,0 +1,101 @@
+require "rdoc/rdoc"
+require "erb"
+
+module RDoc
+  module Generator
+    class Markdown
+      ::RDoc::RDoc.add_generator(self)
+
+      DocClass = Struct.new(
+        :title, :kind, :comment, :class_methods, :instance_methods, :attributes,
+        :constants, :extended, :included, :filename,
+        keyword_init: true,
+      )
+      ClassMember = Struct.new(:title, :comment, :signature, :source_code, keyword_init: true)
+
+      def initialize(store, options)
+        @options = options
+        @store = store
+        @converter = ::RDoc::Markup::ToMarkdown.new
+      end
+
+      def generate
+        render(build_classes)
+      end
+
+      private
+
+      def render(data)
+        class_template_path = File.join(File.dirname(__FILE__), "class_template.md.erb")
+        class_renderer = ERB.new(File.read(class_template_path), nil, "-")
+        data.each do |cls|
+          File.write("#{cls.filename}.md", class_renderer.result(cls.instance_eval { binding }))
+        end
+        index_template_path = File.join(File.dirname(__FILE__), "index_template.md.erb")
+        index_renderer = ERB.new(File.read(index_template_path), nil, "-")
+        File.write("Core-APIs.md", index_renderer.result(OpenStruct.new(classes: data).instance_eval { binding }))
+      end
+
+      def build_classes
+        classes = @store.all_classes_and_modules.map do |klass|
+          is_class = @store.all_modules.find { |m| m.full_name == klass.full_name }.nil?
+          kind = is_class ? :class : :module
+          DocClass.new(
+            filename: "#{kind}-#{klass.full_name}",
+            title: klass.full_name,
+            kind: kind,
+            comment: @converter.convert(klass.comment.parse),
+            constants: build_members(klass.constants),
+            class_methods: build_members(klass.method_list.select { |m| m.type == "class" }),
+            instance_methods: build_members(klass.method_list.select { |m| m.type == "instance" }),
+            attributes: build_members(klass.attributes),
+            extended: build_members(klass.extends),
+            included: build_members(klass.includes),
+          )
+        end
+
+        # Remove nondescript items
+        classes.reject do |klass|
+          klass.comment.empty? && klass.constants.empty? &&
+            klass.class_methods.empty? && klass.instance_methods.empty? &&
+            klass.attributes.empty? && klass.extended.empty? &&
+            klass.included.empty?
+        end
+      end
+
+      def build_members(member_list)
+        member_list.map do |m|
+          ClassMember.new(
+            title:     m.name,
+            comment:   @converter.convert(m.comment.parse),
+            signature: m.respond_to?(:arglists) ? m.arglists : "",
+            source_code: source(m),
+          )
+        end
+      end
+
+      # Just extracts sourcecode from html formatting/highlighting into a text
+      # blob so that markdown can format it with a codeblock
+      def source(m)
+        return "" unless m.respond_to?(:token_stream)
+        # each line, get the text
+        src = (m.token_stream || []).map do |t|
+          next unless t
+          CGI.escapeHTML(t[:text])
+        end.join
+        # dedent the source
+        indent = src.length
+        lines = src.lines.to_a
+        lines.shift if src =~ /\A.*#\ *File/i # remove '# File' comment
+        lines.each do |line|
+          next unless line =~ /^ *(?=\S)/
+          n = Regexp.last_match(0).length
+          indent = n if n < indent
+          break if n == 0
+        end
+        src.gsub!(/^#{' ' * indent}/, "") if indent > 0
+        src
+      end
+    end
+  end
+end

package/assets/cli-ruby/lib/graphql/admin_introspection.graphql

@@ -0,0 +1,87 @@
+query IntrospectionQuery {
+  __schema {
+    queryType { name }
+    mutationType { name }
+    types {
+      ...FullType
+    }
+    directives {
+      name
+      description
+      locations
+      args {
+        ...InputValue
+      }
+    }
+  }
+}
+fragment FullType on __Type {
+  kind
+  name
+  description
+  fields(includeDeprecated: true) {
+    name
+    description
+    args {
+      ...InputValue
+    }
+    type {
+      ...TypeRef
+    }
+    isDeprecated
+    deprecationReason
+  }
+  inputFields {
+    ...InputValue
+  }
+  interfaces {
+    ...TypeRef
+  }
+  enumValues(includeDeprecated: true) {
+    name
+    description
+    isDeprecated
+    deprecationReason
+  }
+  possibleTypes {
+    ...TypeRef
+  }
+}
+fragment InputValue on __InputValue {
+  name
+  description
+  type { ...TypeRef }
+  defaultValue
+}
+fragment TypeRef on __Type {
+  kind
+  name
+  ofType {
+    kind
+    name
+    ofType {
+      kind
+      name
+      ofType {
+        kind
+        name
+        ofType {
+          kind
+          name
+          ofType {
+            kind
+            name
+            ofType {
+              kind
+              name
+              ofType {
+                kind
+                name
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/assets/cli-ruby/lib/graphql/all_organizations.graphql

@@ -0,0 +1,19 @@
+query AllOrgs{
+  organizations {
+    nodes {
+      id
+      businessName
+      website
+      stores(first: 500) {
+        nodes {
+          shopId
+          link
+          shopDomain
+          shopName
+          transferDisabled
+          convertableToPartnerTest
+        }
+      }
+    }
+  }
+}

package/assets/cli-ruby/lib/graphql/all_orgs_with_apps.graphql

@@ -0,0 +1,30 @@
+query AllOrgs{
+  organizations {
+    nodes {
+      id
+      businessName
+      website
+      stores(first: 500) {
+        nodes {
+          shopId
+          link
+          shopDomain
+          shopName
+          transferDisabled
+          convertableToPartnerTest
+        }
+      }
+      apps(first: 500) {
+        nodes {
+          id
+          title
+          apiKey
+          apiSecretKeys{
+            secret
+          }
+          appType
+        }
+      }
+    }
+  }
+}

package/assets/cli-ruby/lib/graphql/api_versions.graphql

@@ -0,0 +1,6 @@
+query {
+  publicApiVersions {
+    handle
+    supported
+  }
+}

package/assets/cli-ruby/lib/graphql/convert_dev_to_test_store.graphql

@@ -0,0 +1,10 @@
+mutation convertDevToTestStore($input: ConvertDevToTestStoreInput!) {
+  convertDevToTestStore(input: $input) {
+    convertedToTestStore
+    userErrors {
+      message
+      field
+    }
+  }
+}
+

package/assets/cli-ruby/lib/graphql/create_app.graphql

@@ -0,0 +1,20 @@
+mutation AppCreate($org: Int!, $title: String!, $app_url: Url!, $redir: [Url]!, $type: AppType) {
+  appCreate(input: {organizationID: $org, title: $title, applicationUrl: $app_url, redirectUrlWhitelist: $redir, appType: $type}) {
+    app {
+      id
+      apiKey
+      title
+      applicationUrl
+      redirectUrlWhitelist
+      apiSecretKeys {
+        secret
+        createdAt
+      }
+      appType
+    }
+    userErrors {
+      field
+      message
+    }
+  }
+}

package/assets/cli-ruby/lib/graphql/create_customer.graphql

@@ -0,0 +1,9 @@
+mutation createCustomer($input: CustomerInput!){
+  customerCreate(input: $input) {
+    customer {
+      id
+      displayName
+    }
+  }
+}
+

package/assets/cli-ruby/lib/graphql/create_draft_order.graphql

@@ -0,0 +1,8 @@
+mutation createDrafOrder($input: DraftOrderInput!){
+  draftOrderCreate(input: $input) {
+    draftOrder {
+      id
+    }
+  }
+}
+

package/assets/cli-ruby/lib/graphql/create_product.graphql

@@ -0,0 +1,9 @@
+mutation createProduct($input: ProductInput!){
+  productCreate(input: $input) {
+    product {
+      id
+      title
+    }
+  }
+}
+

package/assets/cli-ruby/lib/graphql/extension_create.graphql

@@ -0,0 +1,36 @@
+mutation ExtensionCreate(
+  $api_key: String!
+  $type: ExtensionType!
+  $title: String!
+  $config: JSON!
+  $extension_context: String
+) {
+  extensionCreate(
+    input: {
+      apiKey: $api_key
+      type: $type
+      title: $title
+      config: $config
+      context: $extension_context
+    }
+  ) {
+    extensionRegistration {
+      id
+      uuid
+      type
+      title
+      draftVersion {
+        registrationId
+        lastUserInteractionAt
+        validationErrors {
+          field
+          message
+        }
+      }
+    }
+    userErrors {
+      field
+      message
+    }
+  }
+}

package/assets/cli-ruby/lib/graphql/extension_update_draft.graphql

@@ -0,0 +1,18 @@
+mutation ExtensionUpdateDraft($api_key: String!, $registration_id: ID!, $config: JSON!, $context: String) {
+  extensionUpdateDraft(input: {apiKey: $api_key, registrationId: $registration_id, config: $config, context: $context}) {
+    extensionVersion {
+      registrationId
+      context
+      lastUserInteractionAt
+      location
+      validationErrors {
+        field
+        message
+      }
+    }
+    userErrors {
+      field
+      message
+    }
+  }
+}

package/assets/cli-ruby/lib/graphql/fetch_specifications.graphql

@@ -0,0 +1,14 @@
+query fetchSpecifications($api_key: String!) {
+  extensionSpecifications(apiKey: $api_key) {
+    name
+    identifier
+    options {
+      managementExperience
+    }
+    features {
+      argo {
+        surface
+      }
+    }
+  }
+}

package/assets/cli-ruby/lib/graphql/find_organization.graphql

@@ -0,0 +1,18 @@
+query FindOrg($id: ID!) {
+  organizations(id: $id) {
+    nodes {
+      id
+      businessName
+      website
+      stores(first: 500) {
+        nodes {
+          link
+          shopDomain
+          shopName
+          transferDisabled
+          convertableToPartnerTest
+        }
+      }
+    }
+  }
+}

package/assets/cli-ruby/lib/graphql/find_organization_with_apps.graphql

@@ -0,0 +1,20 @@
+query FindOrg($id: ID!) {
+  organizations(id: $id, first: 1) {
+    nodes {
+      id
+      businessName
+      website
+      apps(first: 500) {
+        nodes {
+          id
+          title
+          apiKey
+          apiSecretKeys {
+            secret
+          }
+          appType
+        }
+      }
+    }
+  }
+}

package/assets/cli-ruby/lib/graphql/get_app_by_api_key.graphql

@@ -0,0 +1,9 @@
+query getApp($api_key: String!) {
+  app(apiKey: $api_key) {
+    title
+    apiKey
+    apiSecretKeys{
+      secret
+    }
+  }
+}

package/assets/cli-ruby/lib/graphql/get_app_urls.graphql

@@ -0,0 +1,6 @@
+query getApp($apiKey: String!) {
+  app(apiKey: $apiKey) {
+    applicationUrl
+    redirectUrlWhitelist
+  }
+}

package/assets/cli-ruby/lib/graphql/get_extension_registrations.graphql

@@ -0,0 +1,27 @@
+query GetExtensionRegistrations($api_key: String!, $type: String) {
+  app(apiKey: $api_key) {
+    id
+    title
+    apiKey
+    apiSecretKeys{
+      secret
+    }
+    appType
+    extensionRegistrations(specificationIdentifier: $type) {
+      id
+      type
+      uuid
+      title
+      draftVersion {
+        registrationId
+        context
+        lastUserInteractionAt
+        location
+        validationErrors { field message }
+        id
+        uuid
+        versionTag
+      }
+    }
+  }
+}

package/assets/cli-ruby/lib/graphql/get_variant_id.graphql

@@ -0,0 +1,16 @@
+query {
+  products(first: 1) {
+    edges {
+      node {
+        id
+        variants(first: 1) {
+          edges {
+            node {
+              id
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/assets/cli-ruby/lib/graphql/update_dashboard_urls.graphql

@@ -0,0 +1,8 @@
+mutation appUpdate($input: AppUpdateInput!) {
+  appUpdate(input: $input) {
+    userErrors {
+      message
+      field
+    }
+  }
+}