k9o 1.0.0

data/lib/k9o/client.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module K9o
+  # The customer-facing client returned by K9o.create_client.
+  class K9oClient
+    attr_reader :config, :projects, :gate, :studio, :compute, :realtime, :org,
+                :orgs, :migrations, :functions, :policies, :audit, :me, :kibo, :ai, :storage
+
+    def initialize(config)
+      @config = config
+      @projects = Projects.new(config)
+      @gate = Gate.new(config)
+      @studio = Studio.new(config)
+      @compute = Compute.new(config)
+      @realtime = Realtime.new(config)
+      @org = Org.new(config)
+      @orgs = Orgs.new(config)
+      @migrations = Migrations.new(config)
+      @functions = Functions.new(config)
+      @policies = Policies.new(config)
+      @audit = Audit.new(config)
+      @me = Me.new(config)
+      @kibo = KiboNamespace.new(config)
+      @ai = Ai.new(config)
+      @storage = Storage.new(config)
+    end
+
+    def from(collection)
+      FromBuilder.new(@config, collection)
+    end
+
+    def base_url
+      @config.base_url
+    end
+  end
+
+  # Factory — construct a K9oClient bound to the supplied options.
+  #
+  # Per ch13 §2.1.8 spec sample:
+  #   k9o = K9o.create_client(
+  #     api_key: ENV["K9O_API_KEY"],
+  #     org_slug: "acme",
+  #     project_slug: "member-portal",
+  #   )
+  #
+  # base_url is OPTIONAL. When omitted it
+  # defaults to the platform apex https://api.k9o.io; when the host is the
+  # bare apex and org_slug is set, the canonical org-subdomain wire root
+  # https://<org_slug>.api.k9o.io is composed. Any other host passes through.
+  def self.create_client(base_url: nil, api_key: nil, org_slug: nil, project_slug: nil, default_headers: {}, http_client: nil)
+    normalised = UrlGrammar.resolve_base_url(base_url, org_slug)
+    config = HttpClientConfig.new(
+      base_url: normalised,
+      api_key: api_key, org_slug: org_slug, project_slug: project_slug,
+      default_headers: default_headers, http_client: http_client
+    )
+    K9oClient.new(config)
+  end
+end

data/lib/k9o/compute.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module K9o
+  # Compute namespace (Compute LLMs registry).
+  # k9o.compute.llms.*
+  class Compute
+    # Curated 9-model closed enum per ch07 §10.1 (extensible v2.x).
+    LLM_MODEL_IDS = %w[
+      mistral-7b mistral-8x7b llama-3-8b llama-3-70b
+      claude-3-5-sonnet gpt-4o gpt-4o-mini
+      text-embedding-3-small text-embedding-3-large
+    ].freeze
+
+    attr_reader :llms
+
+    def initialize(config)
+      @llms = Llms.new(config)
+    end
+
+    # k9o.compute.llms.* per ch07 §10.
+    class Llms
+      def initialize(config)
+        @config = config
+      end
+
+      def list(modality: nil)
+        slug = Studio.require_project_slug(@config, 'compute.llms')
+        q = modality ? { 'modality' => modality } : nil
+        HttpTransport.request(config: @config, method: 'GET',
+                              path: UrlGrammar.project_path(slug, 'compute/llms'), query: q)
+      end
+
+      def read(model_id)
+        slug = Studio.require_project_slug(@config, 'compute.llms')
+        HttpTransport.request(config: @config, method: 'GET',
+                              path: UrlGrammar.project_path(slug, "compute/llms/#{enc(model_id)}"))
+      end
+
+      # Synchronous inference per ch07 §10.2 (PROJECT_AUTHOR/ADMIN).
+      def invoke(model_id, prompt:, params: nil)
+        slug = Studio.require_project_slug(@config, 'compute.llms')
+        body = { 'prompt' => prompt }
+        body['params'] = params if params
+        HttpTransport.request(config: @config, method: 'POST',
+                              path: UrlGrammar.project_path(slug, "compute/llms/#{enc(model_id)}/invoke"), body: body)
+      end
+
+      # Streaming inference (SSE per-token) per ch07 §10.2. Returns an
+      # Enumerator of chunk hashes (ch13 §8 Ruby idiom). Consume with
+      # `.each { |chunk| ... }`.
+      def invoke_stream(model_id, prompt:, params: nil)
+        slug = Studio.require_project_slug(@config, 'compute.llms')
+        body = { 'prompt' => prompt }
+        body['params'] = params if params
+        HttpTransport.stream_sse(config: @config, method: 'POST',
+                                 path: UrlGrammar.project_path(slug, "compute/llms/#{enc(model_id)}/invoke-stream"),
+                                 body: body)
+      end
+
+      private
+
+      def enc(s)
+        ::URI.encode_www_form_component(s)
+      end
+    end
+  end
+end

data/lib/k9o/data.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module K9o
+  # Data-plane DSL.
+  #
+  # Usage:
+  #
+  #   response = k9o.from('posts').select.eq('status', 'published').limit(10).execute
+  #   response.data.each { |row| puts row }
+  class FromBuilder
+    def initialize(config, collection)
+      @config = config
+      @collection = collection
+    end
+
+    def select
+      SelectBuilder.new(@config, @collection)
+    end
+
+    def insert(record)
+      HttpTransport.request(
+        config: @config, method: 'POST', path: FromBuilder.collection_path(@config, @collection), body: record
+      )
+    end
+
+    def update(patch)
+      UpdateBuilder.new(@config, @collection, patch)
+    end
+
+    def delete
+      DeleteBuilder.new(@config, @collection)
+    end
+
+    def self.collection_path(config, collection)
+      raise KError.new(
+        code: 'K9O_MISSING_PROJECT_CONTEXT',
+        message: 'data-plane operations require project_slug to be bound on the client',
+        context: { collection: collection },
+        recommendation: 'Pass project_slug: in K9o.create_client(...).'
+      ) if config.project_slug.nil? || config.project_slug.empty?
+
+      unless collection.is_a?(String) && collection.match?(/\A[a-z][a-z0-9_-]{0,62}\z/)
+        raise KError.new(
+          code: 'K9O_INVALID_FIELD_VALUE',
+          message: "collection name #{collection.inspect} does not match required format",
+          context: { collection: collection }
+        )
+      end
+      UrlGrammar.project_path(config.project_slug, "data/#{collection}")
+    end
+  end
+
+  # Shared filter/pagination state.
+  class BaseBuilder
+    def initialize(config, collection)
+      @config = config
+      @collection = collection
+      @filters = []
+      @limit_val = nil
+      @cursor_val = nil
+      @count_mode = nil
+    end
+
+    %i[eq neq gt gte lt lte like ilike is].each do |op|
+      define_method(op) do |column, value|
+        @filters << [column, op.to_s, value.to_s]
+        self
+      end
+    end
+
+    def in_(column, values)
+      @filters << [column, 'in', "(#{values.map(&:to_s).join(',')})"]
+      self
+    end
+
+    def not_in(column, values)
+      @filters << [column, 'notIn', "(#{values.map(&:to_s).join(',')})"]
+      self
+    end
+
+    def filter(column, op, value)
+      @filters << [column, op.to_s, value.to_s]
+      self
+    end
+
+    def limit(n)
+      @limit_val = n
+      self
+    end
+
+    def cursor(opaque)
+      @cursor_val = opaque
+      self
+    end
+
+    def count(mode)
+      @count_mode = mode
+      self
+    end
+
+    protected
+
+    def to_query
+      q = {}
+      @filters.each do |col, op, val|
+        q[col] = val.start_with?('(') ? "#{op}.#{val}" : "#{op}.#{val}"
+      end
+      q['limit'] = @limit_val.to_s if @limit_val
+      q['cursor'] = @cursor_val if @cursor_val
+      q['count'] = @count_mode if @count_mode
+      q
+    end
+  end
+
+  class SelectBuilder < BaseBuilder
+    def execute
+      HttpTransport.request(
+        config: @config, method: 'GET',
+        path: FromBuilder.collection_path(@config, @collection),
+        query: to_query
+      )
+    end
+  end
+
+  class UpdateBuilder < BaseBuilder
+    def initialize(config, collection, patch)
+      super(config, collection)
+      @patch = patch
+    end
+
+    def execute
+      id_filter = @filters.find { |col, op, _| col == 'id' && op == 'eq' }
+      raise KError.new(
+        code: 'K9O_INVALID_FIELD_VALUE',
+        message: 'update() requires .eq("id", ...) filter; row-mass update is not supported at v0.1.0',
+        context: { collection: @collection }
+      ) unless id_filter
+
+      path = "#{FromBuilder.collection_path(@config, @collection)}/#{id_filter[2]}"
+      HttpTransport.request(config: @config, method: 'PATCH', path: path, body: @patch)
+    end
+  end
+
+  class DeleteBuilder < BaseBuilder
+    def execute
+      id_filter = @filters.find { |col, op, _| col == 'id' && op == 'eq' }
+      raise KError.new(
+        code: 'K9O_INVALID_FIELD_VALUE',
+        message: 'delete() requires .eq("id", ...) filter; row-mass delete is not supported at v0.1.0',
+        context: { collection: @collection }
+      ) unless id_filter
+
+      path = "#{FromBuilder.collection_path(@config, @collection)}/#{id_filter[2]}"
+      HttpTransport.request(config: @config, method: 'DELETE', path: path)
+    end
+  end
+end

data/lib/k9o/envelope.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module K9o
+  # Standard ch01 §1.1 envelope returned by every k9o surface on success.
+  class Envelope
+    attr_reader :data, :meta
+
+    def initialize(data:, meta:)
+      @data = data
+      @meta = meta
+    end
+
+    def self.from_wire(wire)
+      Envelope.new(
+        data: wire['data'],
+        meta: Meta.from_wire(wire['meta'] || {})
+      )
+    end
+  end
+
+  # Meta accessor sugar per ch13 §5.
+  class Meta
+    attr_reader :cursor, :subscription, :idempotency, :warnings, :cost, :timing, :context
+
+    def initialize(cursor: nil, subscription: nil, idempotency: nil, warnings: [], cost: {}, timing: nil, context: nil)
+      @cursor = cursor
+      @subscription = subscription
+      @idempotency = idempotency
+      @warnings = warnings
+      @cost = cost
+      @timing = timing
+      @context = context
+    end
+
+    def self.from_wire(wire)
+      cursor = wire['cursor'] ? MetaCursor.new(next_: wire['cursor']['next'], total_count: wire['cursor']['totalCount']) : nil
+      sub = wire['subscription'] ? MetaSubscription.new(is_initial: !!wire['subscription']['isInitial']) : nil
+      idem = wire['idempotency'] ? MetaIdempotency.new(replayed: !!wire['idempotency']['replayed']) : nil
+      warnings = (wire['warnings'] || []).map { |w| MetaWarning.new(code: w['code'] || '', message: w['message'] || '') }
+      timing = wire['timing'] ? MetaTiming.new(total_ms: wire['timing']['totalMs'].to_i) : nil
+      context = wire['context'] && wire['context']['requestId'] ? MetaContext.new(request_id: wire['context']['requestId']) : nil
+      Meta.new(
+        cursor: cursor, subscription: sub, idempotency: idem,
+        warnings: warnings, cost: wire['cost'] || {},
+        timing: timing, context: context
+      )
+    end
+  end
+
+  class MetaCursor
+    attr_reader :next, :total_count
+
+    def initialize(next_:, total_count:)
+      @next = next_
+      @total_count = total_count
+    end
+  end
+
+  MetaSubscription = Struct.new(:is_initial, keyword_init: true)
+  MetaIdempotency = Struct.new(:replayed, keyword_init: true)
+  MetaWarning = Struct.new(:code, :message, keyword_init: true)
+  MetaTiming = Struct.new(:total_ms, keyword_init: true)
+  MetaContext = Struct.new(:request_id, keyword_init: true)
+end

data/lib/k9o/functions.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module K9o
+  # Function lifecycle namespace — k9o.functions.*.
+  class Functions
+    def initialize(config)
+      @config = config
+    end
+
+    def deploy(name:, runtime:, code:, tier: nil, config: nil)
+      slug = require_project_slug
+      body = { 'name' => name, 'runtime' => runtime, 'code' => code }
+      body['tier'] = tier if tier
+      body['config'] = config if config
+      HttpTransport.request(config: @config, method: 'POST', path: UrlGrammar.project_path(slug, 'functions'), body: body)
+    end
+
+    def list(status: nil)
+      slug = require_project_slug
+      q = status ? { 'status' => status } : nil
+      HttpTransport.request(config: @config, method: 'GET', path: UrlGrammar.project_path(slug, 'functions'), query: q)
+    end
+
+    def get(name)
+      slug = require_project_slug
+      HttpTransport.request(config: @config, method: 'GET', path: UrlGrammar.project_path(slug, "functions/#{enc(name)}"))
+    end
+
+    def delete(name)
+      slug = require_project_slug
+      HttpTransport.request(config: @config, method: 'DELETE', path: UrlGrammar.project_path(slug, "functions/#{enc(name)}"))
+    end
+
+    # Invoke a function; payload passed to the runtime verbatim.
+    def invoke(name, payload)
+      slug = require_project_slug
+      HttpTransport.request(config: @config, method: 'POST',
+                            path: UrlGrammar.project_path(slug, "functions/#{enc(name)}/invoke"), body: payload)
+    end
+
+    private
+
+    def require_project_slug
+      Studio.require_project_slug(@config, 'functions')
+    end
+
+    def enc(s)
+      ::URI.encode_www_form_component(s)
+    end
+  end
+end

data/lib/k9o/gate.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module K9o
+  # Gate (Identity-Aware Kernel) namespace. Project-scoped.
+  class Gate
+    def initialize(config)
+      @config = config
+    end
+
+    def sign_up(email:, password:, display_name: nil)
+      body = { 'email' => email, 'password' => password }
+      body['displayName'] = display_name if display_name
+      HttpTransport.request(config: @config, method: 'POST', path: gate_path('signup'), body: body)
+    end
+
+    def sign_in(email:, password:)
+      HttpTransport.request(
+        config: @config, method: 'POST', path: gate_path('signin'),
+        body: { 'email' => email, 'password' => password }
+      )
+    end
+
+    def sign_out(refresh_token: nil)
+      body = refresh_token ? { 'refreshToken' => refresh_token } : {}
+      HttpTransport.request(config: @config, method: 'POST', path: gate_path('signout'), body: body)
+    end
+
+    def whoami
+      HttpTransport.request(config: @config, method: 'GET', path: gate_path('whoami'))
+    end
+
+    def refresh_token(refresh_token:)
+      HttpTransport.request(
+        config: @config, method: 'POST', path: gate_path('refresh'),
+        body: { 'refreshToken' => refresh_token }
+      )
+    end
+
+    def verify_session
+      HttpTransport.request(config: @config, method: 'GET', path: gate_path('verify'))
+    end
+
+    # The project's hosted sign-in URL and WebAuthn rpId:
+    # GET /@<slug>/gate/hosted. Unauthenticated and cacheable; no credential is
+    # sent even when an api_key is configured. Returns an Envelope whose `data`
+    # is { 'signInUrl' => String, 'rpId' => String }. Take both values as given:
+    # an unknown org, a deleted project and a non-Gate project all answer the
+    # same 404 K9O_PROJECT_NOT_FOUND.
+    def hosted
+      HttpTransport.request(config: @config, method: 'GET', path: gate_path('hosted'), authenticated: false)
+    end
+
+    private
+
+    def gate_path(action)
+      raise KError.new(
+        code: 'K9O_MISSING_PROJECT_CONTEXT',
+        message: 'k9o.gate operations require project_slug bound on the client',
+        context: {}
+      ) if @config.project_slug.nil? || @config.project_slug.empty?
+      UrlGrammar.project_path(@config.project_slug, "gate/#{action}")
+    end
+  end
+end