@atproto/api 0.11.0-next.0 → 0.11.0

package/jest.d.ts

@@ -1,20 +0,0 @@
-declare namespace jest {
-  // eslint-disable-next-line
-  interface Matchers<R, T = {}> {
-    toBeModerationResult(
-      expected: ModerationBehaviorResult | undefined,
-      context: string,
-      stringifiedResult: string,
-      ignoreCause?: boolean,
-    ): R
-  }
-
-  interface Expect {
-    toBeModerationResult(
-      expected: ModerationBehaviorResult | undefined,
-      context: string,
-      stringifiedResult: string,
-      ignoreCause?: boolean,
-    ): void
-  }
-}

package/jest.setup.ts

@@ -1,79 +0,0 @@
-import { ModerationBehaviorResult } from './definitions/moderation-behaviors'
-import { ModerationUI } from './src'
-
-expect.extend({
-  toBeModerationResult(
-    actual: ModerationUI,
-    expected: ModerationBehaviorResult | undefined,
-    context: string,
-    stringifiedResult: string,
-    ignoreCause = false,
-  ) {
-    const fail = (msg: string) => ({
-      pass: false,
-      message: () => `${msg}. Full result: ${stringifiedResult}`,
-    })
-    let cause = actual.cause?.type as string
-    if (actual.cause?.type === 'label') {
-      cause = `label:${actual.cause.labelDef.id}`
-    } else if (actual.cause?.type === 'muted') {
-      if (actual.cause.source.type === 'list') {
-        cause = 'muted-by-list'
-      }
-    } else if (actual.cause?.type === 'blocking') {
-      if (actual.cause.source.type === 'list') {
-        cause = 'blocking-by-list'
-      }
-    }
-    if (!expected) {
-      if (!ignoreCause && actual.cause) {
-        return fail(`${context} expected to be a no-op, got ${cause}`)
-      }
-      if (actual.alert) {
-        return fail(`${context} expected to be a no-op, got alert=true`)
-      }
-      if (actual.blur) {
-        return fail(`${context} expected to be a no-op, got blur=true`)
-      }
-      if (actual.filter) {
-        return fail(`${context} expected to be a no-op, got filter=true`)
-      }
-      if (actual.noOverride) {
-        return fail(`${context} expected to be a no-op, got noOverride=true`)
-      }
-    } else {
-      if (!ignoreCause && cause !== expected.cause) {
-        return fail(`${context} expected to be ${expected.cause}, got ${cause}`)
-      }
-      if (!!actual.alert !== !!expected.alert) {
-        return fail(
-          `${context} expected to be alert=${expected.alert || false}, got ${
-            actual.alert || false
-          }`,
-        )
-      }
-      if (!!actual.blur !== !!expected.blur) {
-        return fail(
-          `${context} expected to be blur=${expected.blur || false}, got ${
-            actual.blur || false
-          }`,
-        )
-      }
-      if (!!actual.filter !== !!expected.filter) {
-        return fail(
-          `${context} expected to be filter=${expected.filter || false}, got ${
-            actual.filter || false
-          }`,
-        )
-      }
-      if (!!actual.noOverride !== !!expected.noOverride) {
-        return fail(
-          `${context} expected to be noOverride=${
-            expected.noOverride || false
-          }, got ${actual.noOverride || false}`,
-        )
-      }
-    }
-    return { pass: true, message: () => '' }
-  },
-})

package/scripts/code/label-groups.mjs

@@ -1,68 +0,0 @@
-import * as url from 'url'
-import { readFileSync, writeFileSync } from 'fs'
-import { join } from 'path'
-import * as prettier from 'prettier'
-
-const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
-
-const labelsDef = JSON.parse(
-  readFileSync(
-    join(__dirname, '..', '..', 'definitions', 'labels.json'),
-    'utf8',
-  ),
-)
-const labelGroupsEn = JSON.parse(
-  readFileSync(
-    join(
-      __dirname,
-      '..',
-      '..',
-      'definitions',
-      'locale',
-      'en',
-      'label-groups.json',
-    ),
-    'utf8',
-  ),
-)
-
-writeFileSync(
-  join(__dirname, '..', '..', 'src', 'moderation', 'const', 'label-groups.ts'),
-  await gen(),
-  'utf8',
-)
-
-async function gen() {
-  return prettier.format(
-    `/** this doc is generated by ./scripts/code/labels.mjs **/
-  import {LabelGroupDefinitionMap} from '../types'
-  import {LABELS} from './labels'
-
-  export const LABEL_GROUPS: LabelGroupDefinitionMap = {
-    ${genDefMap()}
-  }
-  `,
-    { semi: false, parser: 'babel', singleQuote: true },
-  )
-}
-
-function genDefMap() {
-  const lines = []
-  for (const group of labelsDef) {
-    lines.push(`"${group.id}": {`)
-    lines.push(`  id: "${group.id}",`)
-    lines.push(`  configurable: ${group.configurable ? true : false},`)
-    lines.push(
-      `  labels: [${group.labels
-        .map((label) => `LABELS["${label.id}"]`)
-        .join(', ')}],`,
-    )
-    lines.push(
-      `  strings: {settings: {en: ${JSON.stringify(labelGroupsEn[group.id])}}}`,
-    )
-    lines.push(`},`)
-  }
-  return lines.join('\n')
-}
-
-export {}

package/scripts/docs/labels.mjs

@@ -1,164 +0,0 @@
-import * as url from 'url'
-import { readFileSync, writeFileSync } from 'fs'
-import { join } from 'path'
-import { stripIndent } from 'common-tags'
-
-const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
-
-const labelsDef = JSON.parse(
-  readFileSync(
-    join(__dirname, '..', '..', 'definitions', 'labels.json'),
-    'utf8',
-  ),
-)
-const labelGroupsEn = JSON.parse(
-  readFileSync(
-    join(
-      __dirname,
-      '..',
-      '..',
-      'definitions',
-      'locale',
-      'en',
-      'label-groups.json',
-    ),
-    'utf8',
-  ),
-)
-const labelsEn = JSON.parse(
-  readFileSync(
-    join(__dirname, '..', '..', 'definitions', 'locale', 'en', 'labels.json'),
-    'utf8',
-  ),
-)
-
-writeFileSync(join(__dirname, '..', '..', 'docs', 'labels.md'), doc(), 'utf8')
-
-function doc() {
-  return stripIndent`
-<!-- this doc is generated by ./scripts/docs/labels.mjs -->
-
-# Labels
-
-This document is a reference for the labels used in the SDK.
-
-**⚠️ Note**: These labels are still in development and may change over time. Not all are currently in use.
-
-## Key
-
-### Label Preferences
-
-The possible client interpretations for a label.
-
-- <code>ignore</code> Do nothing with the label.
-- <code>warn</code> Provide some form of warning on the content (see "On Warn" behavior).
-- <code>hide</code> Remove the content from feeds and apply the warning when directly viewed.
-
-Each label specifies which preferences it can support. If a label is not configurable, it must have only own supported preference.
-
-### Configurable?
-
-Non-configurable labels cannot have their preference changed by the user.
-
-### Flags
-
-Additional behaviors which a label can adopt.
-
-- <code>no-override</code> The user cannot click through any covering of content created by the label.
-- <code>adult</code> The user must have adult content enabled to configure the label. If adult content is not enabled, the label must adopt the strictest preference.
-
-### On Warn
-
-The kind of UI behavior used when a warning must be applied.
-
-- <code>blur</code> Hide all of the content behind an interstitial.
-- <code>blur-media</code> Hide only the media within the content (ie images) behind an interstitial.
-- <code>alert</code> Display a descriptive warning but do not hide the content.
-- <code>null</code> Do nothing.
-
-## Label Behaviors
-
-  <table>
-    <tr>
-      <th>ID</th>
-      <th>Group</th>
-      <th>Preferences</th>
-      <th>Configurable</th>
-      <th>Flags</th>
-      <th>On Warn</th>
-    </tr>
-    ${labelsRef()}
-  </table>
-
-## Label Group Descriptions
-
-  <table>
-    <tr>
-      <th>ID</th>
-      <th>Description</th>
-    </tr>
-    ${labelGroupsDesc()}
-  </table>
-
-## Label Descriptions
-
-  <table>
-    <tr>
-      <th>ID</th>
-      <th>Description</th>
-    </tr>
-    ${labelsDesc()}
-  </table>
-  `
-}
-
-function labelsRef() {
-  const lines = []
-  for (const group of labelsDef) {
-    for (const label of group.labels) {
-      lines.push(stripIndent`
-        <tr>
-          <td>${label.id}</td>
-          <td>${group.id}</td>
-          <td>${label.preferences.join(', ')}</td>
-          <td>${group.configurable ? '✅' : '❌'}</td>
-          <td>${label.flags.join(', ')}</td>
-          <td>${label.onwarn}</td>
-        </tr>
-      `)
-    }
-  }
-  return lines.join('\n')
-}
-
-function labelGroupsDesc() {
-  const lines = []
-  for (const id in labelGroupsEn) {
-    lines.push(stripIndent`
-      <tr>
-        <td>${id}</td>
-        <td><code>general</code><br><strong>${labelGroupsEn[id].name}</strong><br>${labelGroupsEn[id].description}</td>
-      </tr>
-    `)
-  }
-  return lines.join('\n')
-}
-
-function labelsDesc() {
-  const lines = []
-  for (const id in labelsEn) {
-    lines.push(stripIndent`
-      <tr>
-        <td>${id}</td>
-        <td>
-          <code>general</code><br><strong>${labelsEn[id].settings.name}</strong><br>${labelsEn[id].settings.description}<br><br>
-          <code>on an account</code><br><strong>${labelsEn[id].account.name}</strong><br>${labelsEn[id].account.description}<br><br>
-          <code>on content</code><br><strong>${labelsEn[id].content.name}</strong><br>${labelsEn[id].content.description}<br><br>
-        </td>
-      </tr>
-    `)
-  }
-  return lines.join('\n')
-}
-
-export {}

package/scripts/docs/post-moderation-behaviors.mjs

@@ -1,117 +0,0 @@
-import * as url from 'url'
-import { readFileSync, writeFileSync } from 'fs'
-import { join } from 'path'
-import { stripIndents } from 'common-tags'
-
-const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
-
-const postModerationBehaviorsDef = JSON.parse(
-  readFileSync(
-    join(
-      __dirname,
-      '..',
-      '..',
-      'definitions',
-      'post-moderation-behaviors.json',
-    ),
-    'utf8',
-  ),
-)
-
-writeFileSync(
-  join(__dirname, '..', '..', 'docs', 'moderation-behaviors', 'posts.md'),
-  posts(),
-  'utf8',
-)
-
-function posts() {
-  let lastTitle = 'NULL'
-  return stripIndents`
-<!-- this doc is generated by ./scripts/docs/post-moderation-behaviors.mjs -->
-
-# Post moderation behaviors
-
-This document is a reference for the expected behaviors for a post in the application based on some given scenarios. The <code>moderatePost()</code> command condense down to the following yes or no decisions:
-
-- <code>res.content.filter</code> Do not show the post in feeds.
-- <code>res.content.blur</code> Put the post behind a warning cover.
-- <code>res.content.noOverride</code> Do not allow the post's blur cover to be lifted.
-- <code>res.content.alert</code> Add a warning to the post but do not cover it.
-- <code>res.avatar.blur</code> Put the avatar behind a cover.
-- <code>res.avatar.noOverride</code> Do not allow the avatars's blur cover to be lifted.
-- <code>res.avatar.alert</code> Put a warning icon on the avatar.
-- <code>res.embed.blur</code> Put the embed content (media, quote post) behind a warning cover.
-- <code>res.embed.noOverride</code> Do not allow the embed's blur cover to be lifted.
-- <code>res.embed.alert</code> Put a warning on the embed content (media, quote post).
-
-Key:
-
-- ❌ = Filter Content
-- 🚫 = Blur (no-override)
-- ✋ = Blur
-- 🪧 = Alert
-
-## Scenarios
-
-<table>
-  ${Array.from(Object.entries(postModerationBehaviorsDef.scenarios))
-    .map(([title, scenario], i) => {
-      const str = `
-        ${title.indexOf(lastTitle) === -1 ? postTableHead() : ''}
-        ${scenarioSection(title, scenario)}
-      `
-      lastTitle = title.slice(0, 10)
-      return str
-    })
-    .join('')}
-</table>
-  `
-}
-
-function postTableHead() {
-  return `<tr><th>Scenario</th><th>Filter</th><th>Content</th><th>Avatar</th><th>Embed</th></tr>`
-}
-
-function scenarioSection(title, scenario) {
-  return stripIndents`<tr>
-    <td><strong>${title}</strong></td>
-    <td>
-      ${filter(scenario.behaviors.content?.filter)}
-    </td>
-    <td>
-      ${blur(
-        scenario.behaviors.content?.blur,
-        scenario.behaviors.content?.noOverride,
-      )}${alert(scenario.behaviors.content?.alert)}
-    </td>
-    <td>
-      ${blur(
-        scenario.behaviors.avatar?.blur,
-        scenario.behaviors.avatar?.noOverride,
-      )}${alert(scenario.behaviors.avatar?.alert)}
-    </td>
-    <td>
-      ${blur(
-        scenario.behaviors.embed?.blur,
-        scenario.behaviors.embed?.noOverride,
-      )}${alert(scenario.behaviors.embed?.alert)}
-    </td>
-  </tr>`
-}
-
-function filter(val) {
-  return val ? '❌' : ''
-}
-
-function blur(val, noOverride) {
-  if (val) {
-    return noOverride ? '🚫' : '✋'
-  }
-  return ''
-}
-
-function alert(val) {
-  return val ? '🪧' : ''
-}
-
-export {}

package/scripts/docs/profile-moderation-behaviors.mjs

@@ -1,122 +0,0 @@
-import * as url from 'url'
-import { readFileSync, writeFileSync } from 'fs'
-import { join } from 'path'
-import { stripIndents } from 'common-tags'
-
-const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
-
-const profileModerationBehaviorsDef = JSON.parse(
-  readFileSync(
-    join(
-      __dirname,
-      '..',
-      '..',
-      'definitions',
-      'profile-moderation-behaviors.json',
-    ),
-    'utf8',
-  ),
-)
-
-writeFileSync(
-  join(__dirname, '..', '..', 'docs', 'moderation-behaviors', 'profiles.md'),
-  profiles(),
-  'utf8',
-)
-
-function profiles() {
-  let lastTitle = 'NULL'
-  return stripIndents`
-  <!-- this doc is generated by ./scripts/docs/profile-moderation-behaviors.mjs -->
-
-  # Profile moderation behaviors
-  
-  This document is a reference for the expected behaviors for a profile in the application based on some given scenarios. The <code>moderateProfile()</code> command condense down to the following yes or no decisions:
-
-  - <code>res.account.filter</code> Do not show the account in feeds.
-  - <code>res.account.blur</code> Put the account (in listings, when viewing) behind a warning cover.
-  - <code>res.account.noOverride</code> Do not allow the account's blur cover to be lifted.
-  - <code>res.account.alert</code> Add a warning to the account but do not cover it.
-  - <code>res.profile.blur</code> Put the profile details (handle, display name, bio) behind a warning cover.
-  - <code>res.profile.noOverride</code> Do not allow the profile's blur cover to be lifted.
-  - <code>res.profile.alert</code> Add a warning to the profile but do not cover it.
-  - <code>res.avatar.blur</code> Put the avatar behind a cover.
-  - <code>res.avatar.noOverride</code> Do not allow the avatars's blur cover to be lifted.
-  - <code>res.avatar.alert</code> Put a warning icon on the avatar.
- 
-  Key:
-
-  - ❌ = Filter Content
-  - 🚫 = Blur (no-override)
-  - ✋ = Blur
-  - 🪧 = Alert
-
-  ## Scenarios
-
-  <table>
-    ${Array.from(Object.entries(profileModerationBehaviorsDef.scenarios))
-      .map(([title, scenario], i) => {
-        const str = `
-          ${title.indexOf(lastTitle) === -1 ? postTableHead() : ''}
-          ${scenarioSection(title, scenario)}
-        `
-        lastTitle = title.slice(0, 10)
-        return str
-      })
-      .join('\n\n')}
-  </table>
-  `
-}
-
-function postTableHead() {
-  return `<tr><th>Scenario</th><th>Filter</th><th>Account</th><th>Profile</td><th>Avatar</th></tr>`
-}
-
-function scenarioSection(title, scenario) {
-  return stripIndents`
-  <tr>
-    <td><strong>${title}</strong></td>
-    <td>
-      ${filter(scenario.behaviors.account?.filter)}
-    </td>
-    <td>
-      ${blur(
-        scenario.behaviors.account?.blur,
-        scenario.behaviors.account?.noOverride,
-      )}
-      ${alert(scenario.behaviors.account?.alert)}
-    </td>
-    <td>
-      ${blur(
-        scenario.behaviors.profile?.blur,
-        scenario.behaviors.profile?.noOverride,
-      )}
-      ${alert(scenario.behaviors.profile?.alert)}
-    </td>
-    <td>
-      ${blur(
-        scenario.behaviors.avatar?.blur,
-        scenario.behaviors.avatar?.noOverride,
-      )}
-      ${alert(scenario.behaviors.avatar?.alert)}
-    </td>
-  </tr>
-  `
-}
-
-function filter(val) {
-  return val ? '❌' : ''
-}
-
-function blur(val, noOverride) {
-  if (val) {
-    return noOverride ? '🚫' : '✋'
-  }
-  return ''
-}
-
-function alert(val) {
-  return val ? '🪧' : ''
-}
-
-export {}

package/scripts/generate-docs.mjs

@@ -1,5 +0,0 @@
-import './docs/labels.mjs'
-import './docs/post-moderation-behaviors.mjs'
-import './docs/profile-moderation-behaviors.mjs'
-
-export {}