TypeScript SDK

npm install @superartifacts/sdk

import { SuperArtifacts } from '@superartifacts/sdk'

const sa = new SuperArtifacts()

const me = await sa.account.whoami()
console.log(me)

const published = await sa.artifacts.publish({
  slug: 'hello',
  title: 'Hello',
  prompt: 'A page that says hello.',
  html: '<h1>Hello</h1>',
})
console.log(published)

const { artifacts } = await sa.artifacts.list()
console.log(artifacts)

for await (const row of sa.data.iterArtifactRows({ artifact: 'hello' })) {
  console.log(row)
}

await sa.artifacts.update({ artifact: 'hello', visibility: 'private' }, { timeout: 30_000 })

new SuperArtifacts({
  apiKey: process.env.SUPERARTIFACTS_API_KEY, // the default
  baseUrl: 'https://superartifacts.app',      // the default
  timeout: 60_000,                            // milliseconds per attempt
  maxRetries: 2,
  fetch: globalThis.fetch,
})

const page = await sa.artifacts.publish({
  slug: 'launch-notes',
  title: 'Launch notes',
  prompt: 'A page of launch notes.',
  html: '<h1>Launch notes</h1>',
})
console.log(page.url)

import { readFile } from 'node:fs/promises'

await sa.artifacts.publish({
  slug: 'rsvp',
  prompt: 'An RSVP form.',
  html: await readFile('rsvp.html', 'utf8'),
  policy: {
    policyVersion: 1,
    writes: 'upsert',
    perUser: 'single',
    read: 'own',
    retentionDays: null,
    recordCap: { perVisitor: 1, perArtifact: 500 },
    fields: [
      { name: 'attending', type: 'boolean', required: false, pii: 'none', description: 'Yes or no.' },
    ],
  },
})

for await (const row of sa.data.iterArtifactRows({ artifact: 'rsvp' })) {
  console.log(row)
}

await sa.shares.addToArtifact({
  artifact: 'launch-notes',
  emails: ['dana@example.com'],
  role: 'commenter',
})

import { NotFoundError } from '@superartifacts/sdk'

try {
  await sa.artifacts.get({ artifact: 'nope' })
} catch (error) {
  if (error instanceof NotFoundError) console.log(error.code)
  else throw error
}

for await (const row of sa.data.iterRows({ dataset: 'signups' })) console.log(row)
for await (const row of sa.data.iterArtifactRows({ artifact: 'hello' })) console.log(row)
for await (const entry of sa.entries.iter({ collection: 'posts' })) console.log(entry)
for await (const mention of sa.mentions.iter()) console.log(mention)

import { readFile } from 'node:fs/promises'

const { uploadId } = await sa.uploads.upload([
  { path: 'images/hero.png', data: await readFile('hero.png') },
])

await sa.artifacts.publish({
  slug: 'hello',
  prompt: 'A page with a hero image.',
  html: '<img src="images/hero.png">',
  uploads: uploadId,
})