Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move documentation for Node.js adapter into own repo #545

Merged
merged 1 commit into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ pid.txt
tmp/
.vscode/
server/
guides/target
9 changes: 9 additions & 0 deletions guides/attributes.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:project_name: Keycloak
:project_doc_base_url: https://www.keycloak.org/docs/latest
:authorizationguide_name: Authorization Services Guide
:authorizationguide_name_short: Authorization Services
:authorizationguide_link: {project_doc_base_url}/authorization_services/
:project_product: false
:project_community: true
:section: guide
:quickstartRepo_link: https://github.com/keycloak/keycloak-quickstarts
146 changes: 146 additions & 0 deletions guides/guides.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
#!/usr/bin/env node

/*
* Copyright 2024 Red Hat Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/

import childProcess from 'node:child_process'
import fs from 'node:fs'
import path from 'node:path'
import { Readable } from 'node:stream'
import url from 'node:url'
import JSZip from 'jszip'

const donwloadFMPP = async (url, file) => {
if (!fs.existsSync(file)) {
console.log('Downloading fmpp from %s', url)
const response = await fetch(url)
if (!response.ok) {
throw new Error('Error downloading fmpp.')
}
await fs.promises.writeFile(file, Readable.fromWeb(response.body))
}
}

const unzipFMPP = async (targetDir, file) => {
console.log('Unzipping %s', file)
const zip = new JSZip()
const data = fs.readFileSync(file)
const contents = await zip.loadAsync(data)
for (const key of Object.keys(contents.files)) {
const name = path.join(targetDir, key)
const entry = zip.file(key)
if (entry) {
const content = await entry.async('nodebuffer')
fs.writeFileSync(name, content, name.endsWith('/bin/fmpp') ? { mode: 0o755 } : {})
} else if (!fs.existsSync(name)) {
fs.mkdirSync(name)
}
}
}

const executeFMPP = async (version, exe, sourceDir, outputDir) => {
const files = fs.readdirSync(sourceDir)
for (const file of files) {
const statFile = path.join(sourceDir, file)
const stat = fs.statSync(statFile)

if (stat.isDirectory() && file !== 'templates' && file !== 'target' && file !== 'images') {
console.log('Processing folder %s', statFile)
const outputGuideDir = path.join(outputDir, file)
fs.mkdirSync(outputGuideDir)

const files = fs.readdirSync(statFile)
const adocFiles = files.filter(el => path.extname(el) === '.adoc')
for (const adocFile of adocFiles) {
console.log('Processing file %s', adocFile)
const result = childProcess.spawnSync(exe, ['-S', sourceDir, '-O', outputDir,
'-D', 'id:' + path.parse(adocFile).name + ',version:' + version,
path.join(file, adocFile)])
if (result.error) {
throw result.error
}
}
}
}
}

const generateZipFromDirectory = async (zip, dir, root) => {
const files = fs.readdirSync(dir)
files.forEach(function (file) {
file = path.resolve(dir, file)
const stat = fs.statSync(file)
if (stat && stat.isDirectory()) {
generateZipFromDirectory(zip, file, root)
} else {
const filedata = fs.readFileSync(file)
zip.file(path.relative(root, file), filedata)
}
})
}

const generateZip = async (zip, zipFile, dir, root) => {
generateZipFromDirectory(zip, dir, root)
const data = await zip.generateAsync({
type: 'nodebuffer',
compression: 'DEFLATE',
compressionOptions: {
level: 9
}
})
console.log('Generating zip file %s', zipFile)
fs.writeFileSync(zipFile, data)
}

const main = async (version) => {
console.log('Generating guides for version %s', version)

const fmppUrl = 'https://sourceforge.net/projects/fmpp/files/latest/download'
const dir = path.dirname(url.fileURLToPath(import.meta.url))
const targetDir = path.join(dir, 'target')
const fmppZip = path.join(targetDir, 'fmpp.zip')
const fmppExe = path.join(targetDir, 'fmpp', 'bin', 'fmpp')

if (!fs.existsSync(targetDir)) {
fs.mkdirSync(targetDir)
}

let outputDir = path.join(targetDir, 'keycloak-nodejs-connect-guides-' + version)
if (fs.existsSync(outputDir)) {
fs.rmSync(outputDir, { recursive: true })
}
fs.mkdirSync(outputDir)

outputDir = path.join(outputDir, 'generated-guides')
fs.mkdirSync(outputDir)

await donwloadFMPP(fmppUrl, fmppZip)
await unzipFMPP(targetDir, fmppZip)
await executeFMPP(version, fmppExe, dir, outputDir)

fs.cpSync(path.join(dir, 'images'), path.join(outputDir, 'images'), { recursive: true })
fs.cpSync(path.join(dir, 'attributes.adoc'), path.join(outputDir, 'attributes.adoc'))

const zipFile = path.join(targetDir, 'keycloak-nodejs-connect-guides-' + version + '.zip')
generateZip(new JSZip(), zipFile, outputDir, targetDir)
}

if (process.argv.length !== 3) {
console.log('Usage: node generate.js <version>')
process.exit(1)
}

const version = process.argv[2]
main(version)
1 change: 1 addition & 0 deletions guides/images/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading