writeSdkReferenceSections() — supabase Function Reference

Architecture documentation for the writeSdkReferenceSections() function in Reference.generated.script.ts from the supabase codebase.

Function typescript DocumentationSystem ReferenceGen calls 7 called by 1

Entity Profile

DocumentationSystem→ ReferenceGen→ writeSdkReferenceSections() — supabase Function Reference

Dependency Diagram

graph TD
  c54513d8_ea67_94fc_f187_f9ae4cd2e3eb["writeSdkReferenceSections()"]
  35786dbf_245c_1618_e006_4cf71f59bd93["run()"]
  35786dbf_245c_1618_e006_4cf71f59bd93 -->|calls| c54513d8_ea67_94fc_f187_f9ae4cd2e3eb
  45f56962_4cb7_83a3_8932_0438eedf9eb9["flatMap()"]
  c54513d8_ea67_94fc_f187_f9ae4cd2e3eb -->|calls| 45f56962_4cb7_83a3_8932_0438eedf9eb9
  040a5796_eb59_9ff7_60d0_b127fcaa25c2["map()"]
  c54513d8_ea67_94fc_f187_f9ae4cd2e3eb -->|calls| 040a5796_eb59_9ff7_60d0_b127fcaa25c2
  d42fcba3_a2ea_45d2_47b6_6519c0071566["getSpec()"]
  c54513d8_ea67_94fc_f187_f9ae4cd2e3eb -->|calls| d42fcba3_a2ea_45d2_47b6_6519c0071566
  01c8aa19_b021_1f40_7340_9aa3ddf4f724["parseFnsList()"]
  c54513d8_ea67_94fc_f187_f9ae4cd2e3eb -->|calls| 01c8aa19_b021_1f40_7340_9aa3ddf4f724
  2ba77918_c71f_00b4_2b40_c0b152543573["join()"]
  c54513d8_ea67_94fc_f187_f9ae4cd2e3eb -->|calls| 2ba77918_c71f_00b4_2b40_c0b152543573
  3208b6de_e89a_68cd_31fb_acee932136dc["genClientSdkSectionTree()"]
  c54513d8_ea67_94fc_f187_f9ae4cd2e3eb -->|calls| 3208b6de_e89a_68cd_31fb_acee932136dc
  86220fce_b7ec_5580_a5d9_938c3ed97a21["flattenCommonClientLibSections()"]
  c54513d8_ea67_94fc_f187_f9ae4cd2e3eb -->|calls| 86220fce_b7ec_5580_a5d9_938c3ed97a21
  style c54513d8_ea67_94fc_f187_f9ae4cd2e3eb fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/docs/features/docs/Reference.generated.script.ts lines 173–221

async function writeSdkReferenceSections() {
  return Promise.all(
    clientSdkIds
      .flatMap((sdkId) => {
        const versions = REFERENCES[sdkId].versions
        return versions.map((version) => ({
          sdkId,
          version,
        }))
      })
      .flatMap(async ({ sdkId, version }) => {
        const spec = await getSpec(REFERENCES[sdkId].meta[version].specFile)

        const fnsList = await parseFnsList(spec)
        const pendingFnListWrite = writeFile(
          join(GENERATED_DIRECTORY, `${sdkId}.${version}.functions.json`),
          JSON.stringify(fnsList)
        )

        const sdkSectionTree = genClientSdkSectionTree(
          fnsList,
          REFERENCES[sdkId].meta[version].libId
        )
        const pendingSdkSectionTreeWrite = writeFile(
          join(GENERATED_DIRECTORY, `${sdkId}.${version}.sections.json`),
          JSON.stringify(sdkSectionTree)
        )

        const flattenedSdkSections = flattenCommonClientLibSections(sdkSectionTree)
        const pendingFlattenedSdkSectionsWrite = writeFile(
          join(GENERATED_DIRECTORY, `${sdkId}.${version}.flat.json`),
          JSON.stringify(flattenedSdkSections)
        )

        const sdkSectionsBySlug = keyBy(flattenedSdkSections, (section) => section.slug)
        const pendingSdkSlugDictionaryWrite = writeFile(
          join(GENERATED_DIRECTORY, `${sdkId}.${version}.bySlug.json`),
          JSON.stringify(sdkSectionsBySlug)
        )

        return [
          pendingFnListWrite,
          pendingSdkSectionTreeWrite,
          pendingFlattenedSdkSectionsWrite,
          pendingSdkSlugDictionaryWrite,
        ]
      })
  )
}